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.
    - proxyHost
```
String proxyHost
```
      Track proxy host if configured, in case error response came from proxy instead of AWS.
- 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.Access extends Object implements Serializable
  - Serialized Fields
    - actions
```
List<E> actions
```
      A list of actions for the access permissions. Any strings that can be used as an action in an IAM policy can be used in the list of actions to check.
    - resources
```
List<E> resources
```
      A list of resources for the access permissions. Any strings that can be used as a resource in an IAM policy can be used in the list of resources to check.
- Class com.amazonaws.services.accessanalyzer.model.AccessDeniedException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.accessanalyzer.model.AccessPreview extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID for the access preview.
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the access preview.
    - configurations
```
Map<K,V> configurations
```
      A map of resource ARNs for the proposed resource configuration.
    - createdAt
```
Date createdAt
```
      The time at which the access preview was created.
    - status
```
String status
```
      The status of the access preview.
      
      Creating - The access preview creation is in progress.
      
      Completed - The access preview is complete. You can preview findings for external access to the resource.
      
      Failed - The access preview creation has failed.
    - statusReason
```
AccessPreviewStatusReason statusReason
```
      Provides more details about the current status of the access preview.
      
      For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.
- Class com.amazonaws.services.accessanalyzer.model.AccessPreviewFinding extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.
    - existingFindingId
```
String existingFindingId
```
      The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.
    - existingFindingStatus
```
String existingFindingStatus
```
      The existing status of the finding, provided only for existing findings.
    - principal
```
Map<K,V> principal
```
      The external principal that has access to a resource within the zone of trust.
    - action
```
List<E> action
```
      The action in the analyzed policy statement that an external principal has permission to perform.
    - condition
```
Map<K,V> condition
```
      The condition in the analyzed policy statement that resulted in a finding.
    - resource
```
String resource
```
      The resource that an external principal has access to. This is the resource associated with the access preview.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the policy that generated the finding allows public access to the resource.
    - resourceType
```
String resourceType
```
      The type of the resource that can be accessed in the finding.
    - createdAt
```
Date createdAt
```
      The time at which the access preview finding was created.
    - changeType
```
String changeType
```
      Provides context on how the access preview finding compares to existing access identified in IAM Access Analyzer.
      
      New - The finding is for newly-introduced access.
      
      Unchanged - The preview finding is an existing finding that would remain unchanged.
      
      Changed - The preview finding is an existing finding with a change in status.
      
      For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.
    - status
```
String status
```
      The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a Changed finding with preview status Resolved and existing status Active indicates the existing Active finding would become Resolved as a result of the proposed permissions change.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.
    - error
```
String error
```
      An error.
    - sources
```
List<E> sources
```
      The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
- Class com.amazonaws.services.accessanalyzer.model.AccessPreviewStatusReason extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The reason code for the current status of the access preview.
- Class com.amazonaws.services.accessanalyzer.model.AccessPreviewSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID for the access preview.
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the access preview.
    - createdAt
```
Date createdAt
```
      The time at which the access preview was created.
    - status
```
String status
```
      The status of the access preview.
      
      Creating - The access preview creation is in progress.
      
      Completed - The access preview is complete and previews the findings for external access to the resource.
      
      Failed - The access preview creation has failed.
    - statusReason
```
AccessPreviewStatusReason statusReason
```
- Class com.amazonaws.services.accessanalyzer.model.AclGrantee extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The value specified is the canonical user ID of an Amazon Web Services account.
    - uri
```
String uri
```
      Used for granting permissions to a predefined group.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzedResource extends Object implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource that was analyzed.
    - resourceType
```
String resourceType
```
      The type of the resource that was analyzed.
    - createdAt
```
Date createdAt
```
      The time at which the finding was created.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource was analyzed.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was updated.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the policy that generated the finding grants public access to the resource.
    - actions
```
List<E> actions
```
      The actions that an external principal is granted permission to use by the policy that generated the finding.
    - sharedVia
```
List<E> sharedVia
```
      Indicates how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
    - status
```
String status
```
      The current status of the finding generated from the analyzed resource.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource.
    - error
```
String error
```
      An error message.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzedResourceSummary extends Object implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the analyzed resource.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource.
    - resourceType
```
String resourceType
```
      The type of resource that was analyzed.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzerConfiguration extends Object implements Serializable
  - Serialized Fields
    - unusedAccess
```
UnusedAccessConfiguration unusedAccess
```
      Specifies the configuration of an unused access analyzer for an Amazon Web Services organization or account. External access analyzers do not support any configuration.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzerSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the analyzer.
    - name
```
String name
```
      The name of the analyzer.
    - type
```
String type
```
      The type of analyzer, which corresponds to the zone of trust chosen for 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.
    - tags
```
Map<K,V> tags
```
      The tags added to the analyzer.
    - status
```
String status
```
      The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.
    - statusReason
```
StatusReason statusReason
```
      The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.
    - configuration
```
AnalyzerConfiguration configuration
```
      Specifies whether the analyzer is an external access or unused access analyzer.
- Class com.amazonaws.services.accessanalyzer.model.ApplyArchiveRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The Amazon resource name (ARN) of the analyzer.
    - ruleName
```
String ruleName
```
      The name of the rule to apply.
    - clientToken
```
String clientToken
```
      A client token.
- Class com.amazonaws.services.accessanalyzer.model.ApplyArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.ArchiveRuleSummary extends Object implements Serializable
  - Serialized Fields
    - ruleName
```
String ruleName
```
      The name of the archive rule.
    - filter
```
Map<K,V> filter
```
      A filter used to define the archive rule.
    - createdAt
```
Date createdAt
```
      The time at which the archive rule was created.
    - 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.CancelPolicyGenerationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
- Class com.amazonaws.services.accessanalyzer.model.CancelPolicyGenerationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.CheckAccessNotGrantedRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyDocument
```
String policyDocument
```
      The JSON policy document to use as the content for the policy.
    - access
```
List<E> access
```
      An access object containing the permissions that shouldn't be granted by the specified policy. If only actions are specified, IAM Access Analyzer checks for access of the actions on all resources in the policy. If only resources are specified, then IAM Access Analyzer checks which actions have access to the specified resources. If both actions and resources are specified, then IAM Access Analyzer checks which of the specified actions have access to the specified resources.
    - policyType
```
String policyType
```
      The type of policy. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.
      
      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
- Class com.amazonaws.services.accessanalyzer.model.CheckAccessNotGrantedResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - result
```
String result
```
      The result of the check for whether the access is allowed. If the result is PASS, the specified policy doesn't allow any of the specified permissions in the access object. If the result is FAIL, the specified policy might allow some or all of the permissions in the access object.
    - message
```
String message
```
      The message indicating whether the specified access is allowed.
    - reasons
```
List<E> reasons
```
      A description of the reasoning of the result.
- Class com.amazonaws.services.accessanalyzer.model.CheckNoNewAccessRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - newPolicyDocument
```
String newPolicyDocument
```
      The JSON policy document to use as the content for the updated policy.
    - existingPolicyDocument
```
String existingPolicyDocument
```
      The JSON policy document to use as the content for the existing policy.
    - policyType
```
String policyType
```
      The type of policy to compare. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.
      
      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
- Class com.amazonaws.services.accessanalyzer.model.CheckNoNewAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - result
```
String result
```
      The result of the check for new access. If the result is PASS, no new access is allowed by the updated policy. If the result is FAIL, the updated policy might allow new access.
    - message
```
String message
```
      The message indicating whether the updated policy allows new access.
    - reasons
```
List<E> reasons
```
      A description of the reasoning of the result.
- Class com.amazonaws.services.accessanalyzer.model.CheckNoPublicAccessRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyDocument
```
String policyDocument
```
      The JSON policy document to evaluate for public access.
    - resourceType
```
String resourceType
```
      The type of resource to evaluate for public access. For example, to check for public access to Amazon S3 buckets, you can choose AWS::S3::Bucket for the resource type.
      
      For resource types not supported as valid values, IAM Access Analyzer will return an error.
- Class com.amazonaws.services.accessanalyzer.model.CheckNoPublicAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - result
```
String result
```
      The result of the check for public access to the specified resource type. If the result is PASS, the policy doesn't allow public access to the specified resource type. If the result is FAIL, the policy might allow public access to the specified resource type.
    - message
```
String message
```
      The message indicating whether the specified policy allows public access to resources.
    - reasons
```
List<E> reasons
```
      A list of reasons why the specified resource policy grants public access for the resource type.
- Class com.amazonaws.services.accessanalyzer.model.CloudTrailDetails extends Object implements Serializable
  - Serialized Fields
    - trails
```
List<E> trails
```
      A Trail object that contains settings for a trail.
    - accessRole
```
String accessRole
```
      The ARN of the service role that IAM Access Analyzer uses to access your CloudTrail trail and service last accessed information.
    - startTime
```
Date startTime
```
      The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.
    - endTime
```
Date endTime
```
      The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time.
- Class com.amazonaws.services.accessanalyzer.model.CloudTrailProperties extends Object implements Serializable
  - Serialized Fields
    - trailProperties
```
List<E> trailProperties
```
      A TrailProperties object that contains settings for trail properties.
    - startTime
```
Date startTime
```
      The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.
    - endTime
```
Date endTime
```
      The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time.
- Class com.amazonaws.services.accessanalyzer.model.Configuration extends Object implements Serializable
  - Serialized Fields
    - ebsSnapshot
```
EbsSnapshotConfiguration ebsSnapshot
```
      The access control configuration is for an Amazon EBS volume snapshot.
    - ecrRepository
```
EcrRepositoryConfiguration ecrRepository
```
      The access control configuration is for an Amazon ECR repository.
    - iamRole
```
IamRoleConfiguration iamRole
```
      The access control configuration is for an IAM role.
    - efsFileSystem
```
EfsFileSystemConfiguration efsFileSystem
```
      The access control configuration is for an Amazon EFS file system.
    - kmsKey
```
KmsKeyConfiguration kmsKey
```
      The access control configuration is for a KMS key.
    - rdsDbClusterSnapshot
```
RdsDbClusterSnapshotConfiguration rdsDbClusterSnapshot
```
      The access control configuration is for an Amazon RDS DB cluster snapshot.
    - rdsDbSnapshot
```
RdsDbSnapshotConfiguration rdsDbSnapshot
```
      The access control configuration is for an Amazon RDS DB snapshot.
    - secretsManagerSecret
```
SecretsManagerSecretConfiguration secretsManagerSecret
```
      The access control configuration is for a Secrets Manager secret.
    - s3Bucket
```
S3BucketConfiguration s3Bucket
```
      The access control configuration is for an Amazon S3 bucket.
    - snsTopic
```
SnsTopicConfiguration snsTopic
```
      The access control configuration is for an Amazon SNS topic
    - sqsQueue
```
SqsQueueConfiguration sqsQueue
```
      The access control configuration is for an Amazon SQS queue.
    - s3ExpressDirectoryBucket
```
S3ExpressDirectoryBucketConfiguration s3ExpressDirectoryBucket
```
      The access control configuration is for an Amazon S3 directory bucket.
    - dynamodbStream
```
DynamodbStreamConfiguration dynamodbStream
```
      The access control configuration is for a DynamoDB stream.
    - dynamodbTable
```
DynamodbTableConfiguration dynamodbTable
```
      The access control configuration is for a DynamoDB table or index.
- 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.CreateAccessPreviewRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status.
    - configurations
```
Map<K,V> configurations
```
      Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.
    - clientToken
```
String clientToken
```
      A client token.
- Class com.amazonaws.services.accessanalyzer.model.CreateAccessPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID for the access preview.
- Class com.amazonaws.services.accessanalyzer.model.CreateAnalyzerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to create.
    - type
```
String type
```
      The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZATION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
    - 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.
    - tags
```
Map<K,V> tags
```
      An array of key-value pairs to apply to the analyzer.
    - clientToken
```
String clientToken
```
      A client token.
    - configuration
```
AnalyzerConfiguration configuration
```
      Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.
- 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.
    - ruleName
```
String ruleName
```
      The name of the rule to create.
    - filter
```
Map<K,V> filter
```
      The criteria for the rule.
    - clientToken
```
String clientToken
```
      A client token.
- 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
    - eq
```
List<E> eq
```
      An "equals" 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.
    - contains
```
List<E> contains
```
      A "contains" 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.
- 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.
    - ruleName
```
String ruleName
```
      The name of the rule to delete.
    - clientToken
```
String clientToken
```
      A client token.
- Class com.amazonaws.services.accessanalyzer.model.DeleteArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.DynamodbStreamConfiguration extends Object implements Serializable
  - Serialized Fields
    - streamPolicy
```
String streamPolicy
```
      The proposed resource policy defining who can access or manage the DynamoDB stream.
- Class com.amazonaws.services.accessanalyzer.model.DynamodbTableConfiguration extends Object implements Serializable
  - Serialized Fields
    - tablePolicy
```
String tablePolicy
```
      The proposed resource policy defining who can access or manage the DynamoDB table.
- Class com.amazonaws.services.accessanalyzer.model.EbsSnapshotConfiguration extends Object implements Serializable
  - Serialized Fields
    - userIds
```
List<E> userIds
```
      The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
      
      If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
      
      If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
      
      To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    - groups
```
List<E> groups
```
      The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
      
      If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups , then the access preview uses the existing shared groups for the snapshot.
      
      If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
      
      To propose deletion of existing shared groups, you can specify an empty list for groups .
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
      
      If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
      
      If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
- Class com.amazonaws.services.accessanalyzer.model.EcrRepositoryConfiguration extends Object implements Serializable
  - Serialized Fields
    - repositoryPolicy
```
String repositoryPolicy
```
      The JSON repository policy text to apply to the Amazon ECR repository. For more information, see Private repository policy examples in the Amazon ECR User Guide.
- Class com.amazonaws.services.accessanalyzer.model.EfsFileSystemConfiguration extends Object implements Serializable
  - Serialized Fields
    - fileSystemPolicy
```
String fileSystemPolicy
```
      The JSON policy definition to apply to the Amazon EFS file system. For more information on the elements that make up a file system policy, see Amazon EFS Resource-based policies.
- Class com.amazonaws.services.accessanalyzer.model.ExternalAccessDetails 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.
    - condition
```
Map<K,V> condition
```
      The condition in the analyzed policy statement that resulted in an external access finding.
    - isPublic
```
Boolean isPublic
```
      Specifies whether the external access finding is public.
    - principal
```
Map<K,V> principal
```
      The external principal that has access to a resource within the zone of trust.
    - sources
```
List<E> sources
```
      The sources of the external access finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
- Class com.amazonaws.services.accessanalyzer.model.Finding extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the finding.
    - principal
```
Map<K,V> principal
```
      The external principal that has access to a resource within the zone of trust.
    - action
```
List<E> action
```
      The action in the analyzed policy statement that an external principal has permission to use.
    - resource
```
String resource
```
      The resource that an external principal has access to.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the policy that generated the finding allows public access to the resource.
    - resourceType
```
String resourceType
```
      The type of the resource identified in the finding.
    - 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.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource was analyzed.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was updated.
    - status
```
String status
```
      The current status of the finding.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource.
    - error
```
String error
```
      An error.
    - sources
```
List<E> sources
```
      The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
- Class com.amazonaws.services.accessanalyzer.model.FindingDetails extends Object implements Serializable
  - Serialized Fields
    - externalAccessDetails
```
ExternalAccessDetails externalAccessDetails
```
      The details for an external access analyzer finding.
    - unusedPermissionDetails
```
UnusedPermissionDetails unusedPermissionDetails
```
      The details for an unused access analyzer finding with an unused permission finding type.
    - unusedIamUserAccessKeyDetails
```
UnusedIamUserAccessKeyDetails unusedIamUserAccessKeyDetails
```
      The details for an unused access analyzer finding with an unused IAM user access key finding type.
    - unusedIamRoleDetails
```
UnusedIamRoleDetails unusedIamRoleDetails
```
      The details for an unused access analyzer finding with an unused IAM role finding type.
    - unusedIamUserPasswordDetails
```
UnusedIamUserPasswordDetails unusedIamUserPasswordDetails
```
      The details for an unused access analyzer finding with an unused IAM user password finding type.
- Class com.amazonaws.services.accessanalyzer.model.FindingSource extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Indicates the type of access that generated the finding.
    - detail
```
FindingSourceDetail detail
```
      Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
- Class com.amazonaws.services.accessanalyzer.model.FindingSourceDetail extends Object implements Serializable
  - Serialized Fields
    - accessPointArn
```
String accessPointArn
```
      The ARN of the access point that generated the finding. The ARN format depends on whether the ARN represents an access point or a multi-region access point.
    - accessPointAccount
```
String accessPointAccount
```
      The account of the cross-account access point that generated the finding.
- Class com.amazonaws.services.accessanalyzer.model.FindingSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the finding.
    - principal
```
Map<K,V> principal
```
      The external principal that has access to a resource within the zone of trust.
    - action
```
List<E> action
```
      The action in the analyzed policy statement that an external principal has permission to use.
    - resource
```
String resource
```
      The resource that the external principal has access to.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the finding reports a resource that has a policy that allows public access.
    - resourceType
```
String resourceType
```
      The type of the resource that the external principal has access to.
    - 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.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource-based policy that generated the finding was analyzed.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was most recently updated.
    - status
```
String status
```
      The status of the finding.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource.
    - error
```
String error
```
      The error that resulted in an Error finding.
    - sources
```
List<E> sources
```
      The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
- Class com.amazonaws.services.accessanalyzer.model.FindingSummaryV2 extends Object implements Serializable
  - Serialized Fields
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource-based policy or IAM entity that generated the finding was analyzed.
    - 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.
    - 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.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource.
    - status
```
String status
```
      The status of the finding.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was most recently updated.
    - findingType
```
String findingType
```
      The type of the external access or unused access finding.
- Class com.amazonaws.services.accessanalyzer.model.GeneratedPolicy extends Object implements Serializable
  - Serialized Fields
    - policy
```
String policy
```
      The text to use as the content for the new policy. The policy is created using the CreatePolicy action.
- Class com.amazonaws.services.accessanalyzer.model.GeneratedPolicyProperties extends Object implements Serializable
  - Serialized Fields
    - isComplete
```
Boolean isComplete
```
      This value is set to true if the generated policy contains all possible actions for a service that IAM Access Analyzer identified from the CloudTrail trail that you specified, and false otherwise.
    - principalArn
```
String principalArn
```
      The ARN of the IAM entity (user or role) for which you are generating a policy.
    - cloudTrailProperties
```
CloudTrailProperties cloudTrailProperties
```
      Lists details about the Trail used to generated policy.
- Class com.amazonaws.services.accessanalyzer.model.GeneratedPolicyResult extends Object implements Serializable
  - Serialized Fields
    - properties
```
GeneratedPolicyProperties properties
```
      A GeneratedPolicyProperties object that contains properties of the generated policy.
    - generatedPolicies
```
List<E> generatedPolicies
```
      The text to use as the content for the new policy. The policy is created using the CreatePolicy action.
- Class com.amazonaws.services.accessanalyzer.model.GenerateFindingRecommendationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the finding recommendation.
    - id
```
String id
```
      The unique ID for the finding recommendation.
- Class com.amazonaws.services.accessanalyzer.model.GenerateFindingRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.GetAccessPreviewRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessPreviewId
```
String accessPreviewId
```
      The unique ID for the access preview.
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the access preview.
- Class com.amazonaws.services.accessanalyzer.model.GetAccessPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessPreview
```
AccessPreview accessPreview
```
      An object that contains information about the access preview.
- 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 AnalyzedResource object that contains information that IAM 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.GetFindingRecommendationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the finding recommendation.
    - id
```
String id
```
      The unique ID for the finding recommendation.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.GetFindingRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - startedAt
```
Date startedAt
```
      The time at which the retrieval of the finding recommendation was started.
    - completedAt
```
Date completedAt
```
      The time at which the retrieval of the finding recommendation was completed.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - error
```
RecommendationError error
```
      Detailed information about the reason that the retrieval of a recommendation for the finding failed.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource of the finding.
    - recommendedSteps
```
List<E> recommendedSteps
```
      A group of recommended steps for the finding.
    - recommendationType
```
String recommendationType
```
      The type of recommendation for the finding.
    - status
```
String status
```
      The status of the retrieval of the finding recommendation.
- 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.GetFindingV2Request 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.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.GetFindingV2Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource-based policy or IAM entity that generated the finding was analyzed.
    - createdAt
```
Date createdAt
```
      The time at which the finding was created.
    - error
```
String error
```
      An error.
    - id
```
String id
```
      The ID of the finding to retrieve.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - resource
```
String resource
```
      The resource that generated the finding.
    - resourceType
```
String resourceType
```
      The type of the resource identified in the finding.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      Tye Amazon Web Services account ID that owns the resource.
    - status
```
String status
```
      The status of the finding.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was updated.
    - findingDetails
```
List<E> findingDetails
```
      A localized message that explains the finding and provides guidance on how to address it.
    - findingType
```
String findingType
```
      The type of the finding. For external access analyzers, the type is ExternalAccess. For unused access analyzers, the type can be UnusedIAMRole, UnusedIAMUserAccessKey, UnusedIAMUserPassword, or UnusedPermission.
- Class com.amazonaws.services.accessanalyzer.model.GetGeneratedPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
    - includeResourcePlaceholders
```
Boolean includeResourcePlaceholders
```
      The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.
      
      For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead of "*".
    - includeServiceLevelTemplate
```
Boolean includeServiceLevelTemplate
```
      The level of detail that you want to generate. You can specify whether to generate service-level policies.
      
      IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.
- Class com.amazonaws.services.accessanalyzer.model.GetGeneratedPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobDetails
```
JobDetails jobDetails
```
      A GeneratedPolicyDetails object that contains details about the generated policy.
    - generatedPolicyResult
```
GeneratedPolicyResult generatedPolicyResult
```
      A GeneratedPolicyResult object that contains the generated policies and associated details.
- Class com.amazonaws.services.accessanalyzer.model.IamRoleConfiguration extends Object implements Serializable
  - Serialized Fields
    - trustPolicy
```
String trustPolicy
```
      The proposed trust policy for the IAM role.
- Class com.amazonaws.services.accessanalyzer.model.InlineArchiveRule extends Object implements Serializable
  - Serialized Fields
    - ruleName
```
String ruleName
```
      The name of the rule.
    - filter
```
Map<K,V> filter
```
      The condition and values for a criterion.
- 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.InternetConfiguration extends Object implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.InvalidParameterException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.accessanalyzer.model.JobDetails extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
    - status
```
String status
```
      The status of the job request.
    - startedOn
```
Date startedOn
```
      A timestamp of when the job was started.
    - completedOn
```
Date completedOn
```
      A timestamp of when the job was completed.
    - jobError
```
JobError jobError
```
      The job error for the policy generation request.
- Class com.amazonaws.services.accessanalyzer.model.JobError extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The job error code.
    - message
```
String message
```
      Specific information about the error. For example, which service quota was exceeded or which resource was not found.
- Class com.amazonaws.services.accessanalyzer.model.KmsGrantConfiguration extends Object implements Serializable
  - Serialized Fields
    - operations
```
List<E> operations
```
      A list of operations that the grant permits.
    - granteePrincipal
```
String granteePrincipal
```
      The principal that is given permission to perform the operations that the grant permits.
    - retiringPrincipal
```
String retiringPrincipal
```
      The principal that is given permission to retire the grant by using RetireGrant operation.
    - constraints
```
KmsGrantConstraints constraints
```
      Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.
    - issuingAccount
```
String issuingAccount
```
      The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.
- Class com.amazonaws.services.accessanalyzer.model.KmsGrantConstraints extends Object implements Serializable
  - Serialized Fields
    - encryptionContextEquals
```
Map<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.
    - encryptionContextSubset
```
Map<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.
- Class com.amazonaws.services.accessanalyzer.model.KmsKeyConfiguration extends Object implements Serializable
  - Serialized Fields
    - keyPolicies
```
Map<K,V> keyPolicies
```
      Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
    - grants
```
List<E> grants
```
      A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
- Class com.amazonaws.services.accessanalyzer.model.ListAccessPreviewFindingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessPreviewId
```
String accessPreviewId
```
      The unique ID for the access preview.
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the access.
    - filter
```
Map<K,V> filter
```
      Criteria to filter the returned findings.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
- Class com.amazonaws.services.accessanalyzer.model.ListAccessPreviewFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - findings
```
List<E> findings
```
      A list of access preview findings that match the specified filter criteria.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListAccessPreviewsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer used to generate the access preview.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
- Class com.amazonaws.services.accessanalyzer.model.ListAccessPreviewsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessPreviews
```
List<E> accessPreviews
```
      A list of access previews retrieved for the analyzer.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- 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.
    - resourceType
```
String resourceType
```
      The type of resource.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
- 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
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - 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.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the request.
- 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.
    - sort
```
SortCriteria sort
```
      The sort order for the findings returned.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
- 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.ListFindingsV2Request 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
```
- Class com.amazonaws.services.accessanalyzer.model.ListFindingsV2Result 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.ListPolicyGenerationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - principalArn
```
String principalArn
```
      The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to filter the results to only include results for a specific principal.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListPolicyGenerationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policyGenerations
```
List<E> policyGenerations
```
      A PolicyGeneration object that contains details about the generated policy.
    - 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.Location extends Object implements Serializable
  - Serialized Fields
    - path
```
List<E> path
```
      A path in a policy, represented as a sequence of path elements.
    - span
```
Span span
```
      A span in a policy.
- Class com.amazonaws.services.accessanalyzer.model.NetworkOriginConfiguration extends Object implements Serializable
  - Serialized Fields
    - vpcConfiguration
```
VpcConfiguration vpcConfiguration
```
    - internetConfiguration
```
InternetConfiguration internetConfiguration
```
      The configuration for the Amazon S3 access point or multi-region access point with an Internet origin.
- Class com.amazonaws.services.accessanalyzer.model.PathElement extends Object implements Serializable
  - Serialized Fields
    - index
```
Integer index
```
      Refers to an index in a JSON array.
    - key
```
String key
```
      Refers to a key in a JSON object.
    - substring
```
Substring substring
```
      Refers to a substring of a literal string in a JSON object.
    - value
```
String value
```
      Refers to the value associated with a given key in a JSON object.
- Class com.amazonaws.services.accessanalyzer.model.PolicyGeneration extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
    - principalArn
```
String principalArn
```
      The ARN of the IAM entity (user or role) for which you are generating a policy.
    - status
```
String status
```
      The status of the policy generation request.
    - startedOn
```
Date startedOn
```
      A timestamp of when the policy generation started.
    - completedOn
```
Date completedOn
```
      A timestamp of when the policy generation was completed.
- Class com.amazonaws.services.accessanalyzer.model.PolicyGenerationDetails extends Object implements Serializable
  - Serialized Fields
    - principalArn
```
String principalArn
```
      The ARN of the IAM entity (user or role) for which you are generating a policy.
- Class com.amazonaws.services.accessanalyzer.model.Position extends Object implements Serializable
  - Serialized Fields
    - line
```
Integer line
```
      The line of the position, starting from 1.
    - column
```
Integer column
```
      The column of the position, starting from 0.
    - offset
```
Integer offset
```
      The offset within the policy that corresponds to the position, starting from 0.
- Class com.amazonaws.services.accessanalyzer.model.RdsDbClusterSnapshotAttributeValue extends Object implements Serializable
  - Serialized Fields
    - accountIds
```
List<E> accountIds
```
      The Amazon Web Services account IDs that have access to the manual Amazon RDS DB cluster snapshot. If the value all is specified, then the Amazon RDS DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
      
      If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the accountIds in RdsDbClusterSnapshotAttributeValue, then the access preview uses the existing shared accountIds for the snapshot.
      
      If the access preview is for a new resource and you do not specify the specify the accountIds in RdsDbClusterSnapshotAttributeValue, then the access preview considers the snapshot without any attributes.
      
      To propose deletion of existing shared accountIds, you can specify an empty list for accountIds in the RdsDbClusterSnapshotAttributeValue.
- Class com.amazonaws.services.accessanalyzer.model.RdsDbClusterSnapshotConfiguration extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      The names and values of manual DB cluster snapshot attributes. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. The only valid value for AttributeName for the attribute map is restore
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier for an encrypted Amazon RDS DB cluster snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
      
      If the configuration is for an existing Amazon RDS DB cluster snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
      
      If the access preview is for a new resource and you do not specify the specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.
- Class com.amazonaws.services.accessanalyzer.model.RdsDbSnapshotAttributeValue extends Object implements Serializable
  - Serialized Fields
    - accountIds
```
List<E> accountIds
```
      The Amazon Web Services account IDs that have access to the manual Amazon RDS DB snapshot. If the value all is specified, then the Amazon RDS DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
      
      If the configuration is for an existing Amazon RDS DB snapshot and you do not specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview uses the existing shared accountIds for the snapshot.
      
      If the access preview is for a new resource and you do not specify the specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview considers the snapshot without any attributes.
      
      To propose deletion of an existing shared accountIds, you can specify an empty list for accountIds in the RdsDbSnapshotAttributeValue.
- Class com.amazonaws.services.accessanalyzer.model.RdsDbSnapshotConfiguration extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier for an encrypted Amazon RDS DB snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
      
      If the configuration is for an existing Amazon RDS DB snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
      
      If the access preview is for a new resource and you do not specify the specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.
- Class com.amazonaws.services.accessanalyzer.model.ReasonSummary extends Object implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description of the reasoning of a result of checking for access.
    - statementIndex
```
Integer statementIndex
```
      The index number of the reason statement.
    - statementId
```
String statementId
```
      The identifier for the reason statement.
- Class com.amazonaws.services.accessanalyzer.model.RecommendationError extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The error code for a failed retrieval of a recommendation for a finding.
    - message
```
String message
```
      The error message for a failed retrieval of a recommendation for a finding.
- Class com.amazonaws.services.accessanalyzer.model.RecommendedStep extends Object implements Serializable
  - Serialized Fields
    - unusedPermissionsRecommendedStep
```
UnusedPermissionsRecommendedStep unusedPermissionsRecommendedStep
```
      A recommended step for an unused permissions finding.
- 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.S3AccessPointConfiguration extends Object implements Serializable
  - Serialized Fields
    - accessPointPolicy
```
String accessPointPolicy
```
      The access point or multi-region access point policy.
    - publicAccessBlock
```
S3PublicAccessBlockConfiguration publicAccessBlock
```
      The proposed S3PublicAccessBlock configuration to apply to this Amazon S3 access point or multi-region access point.
    - networkOrigin
```
NetworkOriginConfiguration networkOrigin
```
      The proposed Internet and VpcConfiguration to apply to this Amazon S3 access point. VpcConfiguration does not apply to multi-region access points. If the access preview is for a new resource and neither is specified, the access preview uses Internet for the network origin. If the access preview is for an existing resource and neither is specified, the access preview uses the exiting network origin.
- Class com.amazonaws.services.accessanalyzer.model.S3BucketAclGrantConfiguration extends Object implements Serializable
  - Serialized Fields
    - permission
```
String permission
```
      The permissions being granted.
    - grantee
```
AclGrantee grantee
```
      The grantee to whom you’re assigning access rights.
- Class com.amazonaws.services.accessanalyzer.model.S3BucketConfiguration extends Object implements Serializable
  - Serialized Fields
    - bucketPolicy
```
String bucketPolicy
```
      The proposed bucket policy for the Amazon S3 bucket.
    - bucketAclGrants
```
List<E> bucketAclGrants
```
      The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
    - bucketPublicAccessBlock
```
S3PublicAccessBlockConfiguration bucketPublicAccessBlock
```
      The proposed block public access configuration for the Amazon S3 bucket.
    - accessPoints
```
Map<K,V> accessPoints
```
      The configuration of Amazon S3 access points or multi-region access points for the bucket. You can propose up to 10 new access points per bucket.
- Class com.amazonaws.services.accessanalyzer.model.S3ExpressDirectoryBucketConfiguration extends Object implements Serializable
  - Serialized Fields
    - bucketPolicy
```
String bucketPolicy
```
      The proposed bucket policy for the Amazon S3 directory bucket.
- Class com.amazonaws.services.accessanalyzer.model.S3PublicAccessBlockConfiguration extends Object implements Serializable
  - Serialized Fields
    - ignorePublicAcls
```
Boolean ignorePublicAcls
```
      Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.
    - restrictPublicBuckets
```
Boolean restrictPublicBuckets
```
      Specifies whether Amazon S3 should restrict public bucket policies for this bucket.
- Class com.amazonaws.services.accessanalyzer.model.SecretsManagerSecretConfiguration extends Object implements Serializable
  - Serialized Fields
    - kmsKeyId
```
String kmsKeyId
```
      The proposed ARN, key ID, or alias of the KMS key.
    - secretPolicy
```
String secretPolicy
```
      The proposed resource policy defining who can access or manage the secret.
- 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.SnsTopicConfiguration extends Object implements Serializable
  - Serialized Fields
    - topicPolicy
```
String topicPolicy
```
      The JSON policy text that defines who can access an Amazon SNS topic. For more information, see Example cases for Amazon SNS access control in the Amazon SNS Developer Guide.
- 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.Span extends Object implements Serializable
  - Serialized Fields
    - start
```
Position start
```
      The start position of the span (inclusive).
    - end
```
Position end
```
      The end position of the span (exclusive).
- Class com.amazonaws.services.accessanalyzer.model.SqsQueueConfiguration extends Object implements Serializable
  - Serialized Fields
    - queuePolicy
```
String queuePolicy
```
      The proposed resource policy for the Amazon SQS queue.
- Class com.amazonaws.services.accessanalyzer.model.StartPolicyGenerationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyGenerationDetails
```
PolicyGenerationDetails policyGenerationDetails
```
      Contains the ARN of the IAM entity (user or role) for which you are generating a policy.
    - cloudTrailDetails
```
CloudTrailDetails cloudTrailDetails
```
      A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
      
      If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
- Class com.amazonaws.services.accessanalyzer.model.StartPolicyGenerationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.
- 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.
    - resourceOwnerAccount
```
String resourceOwnerAccount
```
      The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.
- Class com.amazonaws.services.accessanalyzer.model.StartResourceScanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.StatusReason extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The reason code for the current status of the analyzer.
- Class com.amazonaws.services.accessanalyzer.model.Substring extends Object implements Serializable
  - Serialized Fields
    - start
```
Integer start
```
      The start index of the substring, starting from 0.
    - length
```
Integer length
```
      The length of the substring.
- 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.Trail extends Object implements Serializable
  - Serialized Fields
    - cloudTrailArn
```
String cloudTrailArn
```
      Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
    - regions
```
List<E> regions
```
      A list of regions to get CloudTrail data from and analyze to generate a policy.
    - allRegions
```
Boolean allRegions
```
      Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
- Class com.amazonaws.services.accessanalyzer.model.TrailProperties extends Object implements Serializable
  - Serialized Fields
    - cloudTrailArn
```
String cloudTrailArn
```
      Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
    - regions
```
List<E> regions
```
      A list of regions to get CloudTrail data from and analyze to generate a policy.
    - allRegions
```
Boolean allRegions
```
      Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
- Class com.amazonaws.services.accessanalyzer.model.UnprocessableEntityException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
- 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.UnusedAccessConfiguration extends Object implements Serializable
  - Serialized Fields
    - unusedAccessAge
```
Integer unusedAccessAge
```
      The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days.
- Class com.amazonaws.services.accessanalyzer.model.UnusedAction extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action for which the unused access finding was generated.
    - lastAccessed
```
Date lastAccessed
```
      The time at which the action was last accessed.
- Class com.amazonaws.services.accessanalyzer.model.UnusedIamRoleDetails extends Object implements Serializable
  - Serialized Fields
    - lastAccessed
```
Date lastAccessed
```
      The time at which the role was last accessed.
- Class com.amazonaws.services.accessanalyzer.model.UnusedIamUserAccessKeyDetails extends Object implements Serializable
  - Serialized Fields
    - accessKeyId
```
String accessKeyId
```
      The ID of the access key for which the unused access finding was generated.
    - lastAccessed
```
Date lastAccessed
```
      The time at which the access key was last accessed.
- Class com.amazonaws.services.accessanalyzer.model.UnusedIamUserPasswordDetails extends Object implements Serializable
  - Serialized Fields
    - lastAccessed
```
Date lastAccessed
```
      The time at which the password was last accessed.
- Class com.amazonaws.services.accessanalyzer.model.UnusedPermissionDetails extends Object implements Serializable
  - Serialized Fields
    - actions
```
List<E> actions
```
      A list of unused actions for which the unused access finding was generated.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the Amazon Web Services service that contains the unused actions.
    - lastAccessed
```
Date lastAccessed
```
      The time at which the permission was last accessed.
- Class com.amazonaws.services.accessanalyzer.model.UnusedPermissionsRecommendedStep extends Object implements Serializable
  - Serialized Fields
    - policyUpdatedAt
```
Date policyUpdatedAt
```
      The time at which the existing policy for the unused permissions finding was last updated.
    - recommendedAction
```
String recommendedAction
```
      A recommendation of whether to create or detach a policy for an unused permissions finding.
    - recommendedPolicy
```
String recommendedPolicy
```
      If the recommended action for the unused permissions finding is to replace the existing policy, the contents of the recommended policy to replace the policy specified in the existingPolicyId field.
    - existingPolicyId
```
String existingPolicyId
```
      If the recommended action for the unused permissions finding is to detach a policy, the ID of an existing policy to be detached.
- 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.
    - ruleName
```
String ruleName
```
      The name of the rule to update.
    - filter
```
Map<K,V> filter
```
      A filter to match for the rules to update. Only rules that match the filter are updated.
    - clientToken
```
String clientToken
```
      A client token.
- 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.
    - 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.
    - ids
```
List<E> ids
```
      The IDs of the findings to update.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource identified in the finding.
    - clientToken
```
String clientToken
```
      A client token.
- Class com.amazonaws.services.accessanalyzer.model.UpdateFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.ValidatePolicyFinding extends Object implements Serializable
  - Serialized Fields
    - findingDetails
```
String findingDetails
```
      A localized message that explains the finding and provides guidance on how to address it.
    - findingType
```
String findingType
```
      The impact of the finding.
      
      Security warnings report when the policy allows access that we consider overly permissive.
      
      Errors report when a part of the policy is not functional.
      
      Warnings report non-security issues when a policy does not conform to policy writing best practices.
      
      Suggestions recommend stylistic improvements in the policy that do not impact access.
    - issueCode
```
String issueCode
```
      The issue code provides an identifier of the issue associated with this finding.
    - learnMoreLink
```
String learnMoreLink
```
      A link to additional documentation about the type of finding.
    - locations
```
List<E> locations
```
      The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.
- Class com.amazonaws.services.accessanalyzer.model.ValidatePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - locale
```
String locale
```
      The locale to use for localizing the findings.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - policyDocument
```
String policyDocument
```
      The JSON policy document to use as the content for the policy.
    - policyType
```
String policyType
```
      The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.
      
      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
      
      Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.
    - validatePolicyResourceType
```
String validatePolicyResourceType
```
      The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
      
      For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.
- Class com.amazonaws.services.accessanalyzer.model.ValidatePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - findings
```
List<E> findings
```
      The list of findings in a policy returned by IAM Access Analyzer based on its suite of policy checks.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ValidationException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
      The reason for the exception.
    - fieldList
```
List<E> fieldList
```
      A list of fields that didn't validate.
- Class com.amazonaws.services.accessanalyzer.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the validation exception.
    - message
```
String message
```
      A message about the validation exception.
- Class com.amazonaws.services.accessanalyzer.model.VpcConfiguration extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      If this field is specified, this access point will only allow connections from the specified VPC ID.
Package com.amazonaws.services.account.model
- Class com.amazonaws.services.account.model.AcceptPrimaryEmailUpdateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      This operation can only be called from the management account or the delegated administrator account of an organization for a member account.
      
      The management account can't specify its own AccountId.
    - otp
```
String otp
```
      The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.
    - primaryEmail
```
String primaryEmail
```
      The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.
- Class com.amazonaws.services.account.model.AcceptPrimaryEmailUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Retrieves the status of the accepted primary email update request.
- Class com.amazonaws.services.account.model.AccessDeniedException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.AlternateContact extends Object implements Serializable
  - Serialized Fields
    - alternateContactType
```
String alternateContactType
```
      The type of alternate contact.
    - emailAddress
```
String emailAddress
```
      The email address associated with this alternate contact.
    - name
```
String name
```
      The name associated with this alternate contact.
    - phoneNumber
```
String phoneNumber
```
      The phone number associated with this alternate contact.
    - title
```
String title
```
      The title associated with this alternate contact.
- Class com.amazonaws.services.account.model.AWSAccountException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.ConflictException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.ContactInformation extends Object implements Serializable
  - Serialized Fields
    - addressLine1
```
String addressLine1
```
      The first line of the primary contact address.
    - addressLine2
```
String addressLine2
```
      The second line of the primary contact address, if any.
    - addressLine3
```
String addressLine3
```
      The third line of the primary contact address, if any.
    - city
```
String city
```
      The city of the primary contact address.
    - companyName
```
String companyName
```
      The name of the company associated with the primary contact information, if any.
    - countryCode
```
String countryCode
```
      The ISO-3166 two-letter country code for the primary contact address.
    - districtOrCounty
```
String districtOrCounty
```
      The district or county of the primary contact address, if any.
    - fullName
```
String fullName
```
      The full name of the primary contact address.
    - phoneNumber
```
String phoneNumber
```
      The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
    - postalCode
```
String postalCode
```
      The postal code of the primary contact address.
    - stateOrRegion
```
String stateOrRegion
```
      The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, NJ) or the full state name (for example, New Jersey). This field is required in the following countries: US, CA, GB, DE, JP, IN, and BR.
    - websiteUrl
```
String websiteUrl
```
      The URL of the website associated with the primary contact information, if any.
- Class com.amazonaws.services.account.model.DeleteAlternateContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
      
      If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
      
      To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - alternateContactType
```
String alternateContactType
```
      Specifies which of the alternate contacts to delete.
- Class com.amazonaws.services.account.model.DeleteAlternateContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.account.model.DisableRegionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - regionName
```
String regionName
```
      Specifies the Region-code for a given Region name (for example, af-south-1). When you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.
- Class com.amazonaws.services.account.model.DisableRegionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.account.model.EnableRegionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - regionName
```
String regionName
```
      Specifies the Region-code for a given Region name (for example, af-south-1). When you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such as distributing your IAM resources to the Region. This process takes a few minutes for most accounts, but it can take several hours. You cannot use the Region until this process is complete. Furthermore, you cannot disable the Region until the enabling process is fully completed.
- Class com.amazonaws.services.account.model.EnableRegionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.account.model.GetAlternateContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
      
      If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
      
      To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - alternateContactType
```
String alternateContactType
```
      Specifies which alternate contact you want to retrieve.
- Class com.amazonaws.services.account.model.GetAlternateContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alternateContact
```
AlternateContact alternateContact
```
      A structure that contains the details for the specified alternate contact.
- Class com.amazonaws.services.account.model.GetContactInformationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
- Class com.amazonaws.services.account.model.GetContactInformationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contactInformation
```
ContactInformation contactInformation
```
      Contains the details of the primary contact information associated with an Amazon Web Services account.
- Class com.amazonaws.services.account.model.GetPrimaryEmailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      This operation can only be called from the management account or the delegated administrator account of an organization for a member account.
      
      The management account can't specify its own AccountId.
- Class com.amazonaws.services.account.model.GetPrimaryEmailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - primaryEmail
```
String primaryEmail
```
      Retrieves the primary email address associated with the specified account.
- Class com.amazonaws.services.account.model.GetRegionOptStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - regionName
```
String regionName
```
      Specifies the Region-code for a given Region name (for example, af-south-1). This function will return the status of whatever Region you pass into this parameter.
- Class com.amazonaws.services.account.model.GetRegionOptStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - regionName
```
String regionName
```
      The Region code that was passed in.
    - regionOptStatus
```
String regionOptStatus
```
      One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
- Class com.amazonaws.services.account.model.InternalServerException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.ListRegionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - maxResults
```
Integer maxResults
```
      The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
    - nextToken
```
String nextToken
```
      A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
    - regionOptStatusContains
```
List<E> regionOptStatusContains
```
      A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
- Class com.amazonaws.services.account.model.ListRegionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If there is more data to be returned, this will be populated. It should be passed into the next-token request parameter of list-regions.
    - regions
```
List<E> regions
```
      This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the filter parameter.
- Class com.amazonaws.services.account.model.PutAlternateContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
      
      If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
      
      To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - alternateContactType
```
String alternateContactType
```
      Specifies which alternate contact you want to create or update.
    - emailAddress
```
String emailAddress
```
      Specifies an email address for the alternate contact.
    - name
```
String name
```
      Specifies a name for the alternate contact.
    - phoneNumber
```
String phoneNumber
```
      Specifies a phone number for the alternate contact.
    - title
```
String title
```
      Specifies a title for the alternate contact.
- Class com.amazonaws.services.account.model.PutAlternateContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.account.model.PutContactInformationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      The management account can't specify its own AccountId. It must call the operation in standalone context by not including the AccountId parameter.
      
      To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
    - contactInformation
```
ContactInformation contactInformation
```
      Contains the details of the primary contact information associated with an Amazon Web Services account.
- Class com.amazonaws.services.account.model.PutContactInformationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.account.model.Region extends Object implements Serializable
  - Serialized Fields
    - regionName
```
String regionName
```
      The Region code of a given Region (for example, us-east-1).
    - regionOptStatus
```
String regionOptStatus
```
      One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
- Class com.amazonaws.services.account.model.ResourceNotFoundException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.StartPrimaryEmailUpdateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
      
      This operation can only be called from the management account or the delegated administrator account of an organization for a member account.
      
      The management account can't specify its own AccountId.
    - primaryEmail
```
String primaryEmail
```
      The new primary email address (also known as the root user email address) to use in the specified account.
- Class com.amazonaws.services.account.model.StartPrimaryEmailUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the primary email update request.
- Class com.amazonaws.services.account.model.TooManyRequestsException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.account.model.ValidationException extends AWSAccountException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldList
```
List<E> fieldList
```
      The field where the invalid entry was detected.
    - reason
```
String reason
```
      The reason that validation failed.
- Class com.amazonaws.services.account.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message about the validation exception.
    - name
```
String name
```
      The field name where the invalid entry was detected.
Package com.amazonaws.services.acmpca.model
- Class com.amazonaws.services.acmpca.model.AccessDescription extends Object implements Serializable
  - Serialized Fields
    - accessMethod
```
AccessMethod accessMethod
```
      The type and format of AccessDescription information.
    - accessLocation
```
GeneralName accessLocation
```
      The location of AccessDescription information.
- Class com.amazonaws.services.acmpca.model.AccessMethod extends Object implements Serializable
  - Serialized Fields
    - customObjectIdentifier
```
String customObjectIdentifier
```
      An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).
    - accessMethodType
```
String accessMethodType
```
      Specifies the AccessMethod.
- Class com.amazonaws.services.acmpca.model.ApiPassthrough extends Object implements Serializable
  - Serialized Fields
    - extensions
```
Extensions extensions
```
      Specifies X.509 extension information for a certificate.
    - subject
```
ASN1Subject subject
```
- 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
```
      For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
      
      Note: In publicly trusted certificates, the common name must be a 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.
    - customAttributes
```
List<E> customAttributes
```
      Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).
      
      Custom attributes cannot be used in combination with standard attributes.
- 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 .
    - ownerAccount
```
String ownerAccount
```
      The Amazon Web Services account ID that owns the certificate authority.
    - 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 Online Certificate Status Protocol (OCSP) configuration or 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.
    - keyStorageSecurityStandard
```
String keyStorageSecurityStandard
```
      Defines a cryptographic key management compliance standard used for handling CA keys.
      
      Default: FIPS_140_2_LEVEL_3_OR_HIGHER
      
      Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    - usageMode
```
String usageMode
```
      Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
      
      The default value is GENERAL_PURPOSE.
- 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.
      
      This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.
    - subject
```
ASN1Subject subject
```
      Structure that contains X.500 distinguished name information for your private CA.
    - csrExtensions
```
CsrExtensions csrExtensions
```
      Specifies information to be added to the extension section of the certificate signing request (CSR).
- 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 information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
      
      The following requirements apply to revocation configurations.
      
      A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
      
      In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
      
      A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
      
      In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
      
      For more information, see the OcspConfiguration and CrlConfiguration types.
    - certificateAuthorityType
```
String certificateAuthorityType
```
      The type of the certificate authority.
    - idempotencyToken
```
String idempotencyToken
```
      Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
    - keyStorageSecurityStandard
```
String keyStorageSecurityStandard
```
      Specifies a cryptographic key management compliance standard used for handling CA keys.
      
      Default: FIPS_140_2_LEVEL_3_OR_HIGHER
      
      Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard. Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."
      
      For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
    - 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.
    - usageMode
```
String usageMode
```
      Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
      
      The default value is GENERAL_PURPOSE.
- 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 Amazon Web Services 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 Amazon Web Services 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
```
      Validity period of the CRL in days.
    - 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.
      
      The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
    - 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 operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.
      
      The S3BucketName parameter must conform to the S3 bucket naming rules.
    - s3ObjectAcl
```
String s3ObjectAcl
```
      Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.
      
      If no value is specified, the default is PUBLIC_READ.
      
      Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
      
      For more information, see Blocking public access to the S3 bucket.
    - crlDistributionPointExtensionConfiguration
```
CrlDistributionPointExtensionConfiguration crlDistributionPointExtensionConfiguration
```
      Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.
- Class com.amazonaws.services.acmpca.model.CrlDistributionPointExtensionConfiguration extends Object implements Serializable
  - Serialized Fields
    - omitExtension
```
Boolean omitExtension
```
      Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.
      
      Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger
      
      This configuration cannot be enabled with a custom CNAME set.
- Class com.amazonaws.services.acmpca.model.CsrExtensions extends Object implements Serializable
  - Serialized Fields
    - keyUsage
```
KeyUsage keyUsage
```
      Indicates the purpose of the certificate and of the key contained in the certificate.
    - subjectInformationAccess
```
List<E> subjectInformationAccess
```
      For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.
- Class com.amazonaws.services.acmpca.model.CustomAttribute extends Object implements Serializable
  - Serialized Fields
    - objectIdentifier
```
String objectIdentifier
```
      Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
    - value
```
String value
```
      Specifies the attribute value of relative distinguished name (RDN).
- Class com.amazonaws.services.acmpca.model.CustomExtension extends Object implements Serializable
  - Serialized Fields
    - objectIdentifier
```
String objectIdentifier
```
      Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.
    - value
```
String value
```
      Specifies the base64-encoded value of the X.509 extension.
    - critical
```
Boolean critical
```
      Specifies the critical flag of the X.509 extension.
- 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 Amazon Web Services 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 Amazon Web Services account that calls this action.
- Class com.amazonaws.services.acmpca.model.DeletePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.
- Class com.amazonaws.services.acmpca.model.DeletePolicyResult 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.EdiPartyName extends Object implements Serializable
  - Serialized Fields
    - partyName
```
String partyName
```
      Specifies the party name.
    - nameAssigner
```
String nameAssigner
```
      Specifies the name assigner.
- Class com.amazonaws.services.acmpca.model.ExtendedKeyUsage extends Object implements Serializable
  - Serialized Fields
    - extendedKeyUsageType
```
String extendedKeyUsageType
```
      Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.
    - extendedKeyUsageObjectIdentifier
```
String extendedKeyUsageObjectIdentifier
```
      Specifies a custom ExtendedKeyUsage with an object identifier (OID).
- Class com.amazonaws.services.acmpca.model.Extensions extends Object implements Serializable
  - Serialized Fields
    - certificatePolicies
```
List<E> certificatePolicies
```
      Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).
      
      In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
    - extendedKeyUsage
```
List<E> extendedKeyUsage
```
      Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
    - keyUsage
```
KeyUsage keyUsage
```
    - subjectAlternativeNames
```
List<E> subjectAlternativeNames
```
      The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.
    - customExtensions
```
List<E> customExtensions
```
      Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.
- Class com.amazonaws.services.acmpca.model.GeneralName extends Object implements Serializable
  - Serialized Fields
    - otherName
```
OtherName otherName
```
      Represents GeneralName using an OtherName object.
    - rfc822Name
```
String rfc822Name
```
      Represents GeneralName as an RFC 822 email address.
    - dnsName
```
String dnsName
```
      Represents GeneralName as a DNS name.
    - directoryName
```
ASN1Subject directoryName
```
    - ediPartyName
```
EdiPartyName ediPartyName
```
      Represents GeneralName as an EdiPartyName object.
    - uniformResourceIdentifier
```
String uniformResourceIdentifier
```
      Represents GeneralName as a URI.
    - ipAddress
```
String ipAddress
```
      Represents GeneralName as an IPv4 or IPv6 address.
    - registeredId
```
String registeredId
```
      Represents GeneralName as an object identifier (OID).
- 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 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 root CA certificate that you used to sign your private CA certificate.
- Class com.amazonaws.services.acmpca.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
      </p>
- Class com.amazonaws.services.acmpca.model.GetPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policy
```
String policy
```
      The policy attached to the private CA as a JSON document.
- 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 Amazon Web Services 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
    - apiPassthrough
```
ApiPassthrough apiPassthrough
```
      Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.
      
      If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
    - 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. As an example, 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 then 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
      
      Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
    - signingAlgorithm
```
String signingAlgorithm
```
      The name of the algorithm that will be used to sign the certificate to be issued.
      
      This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.
      
      The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
    - templateArn
```
String templateArn
```
      Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.
      
      Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
      
      For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.
    - validity
```
Validity validity
```
      Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.
      
      Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
      
      This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.
      
      The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
    - validityNotBefore
```
Validity validityNotBefore
```
      Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
      
      By default, when issuing a certificate, Amazon Web Services Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.
      
      Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
      
      The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.
    - idempotencyToken
```
String idempotencyToken
```
      Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA 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.KeyUsage extends Object implements Serializable
  - Serialized Fields
    - digitalSignature
```
Boolean digitalSignature
```
      Key can be used for digital signing.
    - nonRepudiation
```
Boolean nonRepudiation
```
      Key can be used for non-repudiation.
    - keyEncipherment
```
Boolean keyEncipherment
```
      Key can be used to encipher data.
    - dataEncipherment
```
Boolean dataEncipherment
```
      Key can be used to decipher data.
    - keyAgreement
```
Boolean keyAgreement
```
      Key can be used in a key-agreement protocol.
    - keyCertSign
```
Boolean keyCertSign
```
      Key can be used to sign certificates.
    - cRLSign
```
Boolean cRLSign
```
      Key can be used to sign CRLs.
    - encipherOnly
```
Boolean encipherOnly
```
      Key can be used only to encipher data.
    - decipherOnly
```
Boolean decipherOnly
```
      Key can be used only to decipher data.
- 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
    - 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.
      
      Although the maximum value is 1000, the action only returns a maximum of 100 items.
    - 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.
    - resourceOwner
```
String resourceOwner
```
      Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.
- Class com.amazonaws.services.acmpca.model.ListCertificateAuthoritiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - 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.
    - certificateAuthorities
```
List<E> certificateAuthorities
```
      Summary information about each certificate authority you have created.
- Class com.amazonaws.services.acmpca.model.ListPermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - 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.
    - 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.
    - 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.
- Class com.amazonaws.services.acmpca.model.ListPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - 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.
    - 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.
- Class com.amazonaws.services.acmpca.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - 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.
    - 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.
    - 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.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - 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.
    - tags
```
List<E> tags
```
      The tags associated with your private CA.
- Class com.amazonaws.services.acmpca.model.LockoutPreventedException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- 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.OcspConfiguration extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
    - ocspCustomCname
```
String ocspCustomCname
```
      By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.
      
      The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
      
      For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
- Class com.amazonaws.services.acmpca.model.OtherName extends Object implements Serializable
  - Serialized Fields
    - typeId
```
String typeId
```
      Specifies an OID.
    - value
```
String value
```
      Specifies an OID value.
- 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 Amazon Web Services 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 Amazon Web Services 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.PolicyInformation extends Object implements Serializable
  - Serialized Fields
    - certPolicyId
```
String certPolicyId
```
      Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).
    - policyQualifiers
```
List<E> policyQualifiers
```
      Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.
- Class com.amazonaws.services.acmpca.model.PolicyQualifierInfo extends Object implements Serializable
  - Serialized Fields
    - policyQualifierId
```
String policyQualifierId
```
      Identifies the qualifier modifying a CertPolicyId.
    - qualifier
```
Qualifier qualifier
```
      Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.
- Class com.amazonaws.services.acmpca.model.PutPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.
    - policy
```
String policy
```
      The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.
- Class com.amazonaws.services.acmpca.model.PutPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.Qualifier extends Object implements Serializable
  - Serialized Fields
    - cpsUri
```
String cpsUri
```
      Contains a pointer to a certification practice statement (CPS) published by the CA.
- 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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
    - ocspConfiguration
```
OcspConfiguration ocspConfiguration
```
      Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
- 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 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
```
      Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.
      
      The following requirements apply to revocation configurations.
      
      A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
      
      In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
      
      A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
      
      In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
    - 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
```
      A long integer interpreted according to the value of Type, below.
    - type
```
String type
```
      Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.
      
      END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.
      
      Sample input value: 491231235959 (UTCTime format)
      
      Output expiration date/time: 12/31/2049 23:59:59
      
      ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.
      
      Sample input value: 2524608000
      
      Output expiration date/time: 01/01/2050 00:00:00
      
      DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.
      
      Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
      
      Sample input value: 90
      
      Output expiration date: 01/10/2020 12:34:54 UTC
      
      The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.
Package com.amazonaws.services.amplify.model
- Class com.amazonaws.services.amplify.model.App extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app.
    - appArn
```
String appArn
```
      The Amazon Resource Name (ARN) of the Amplify app.
    - name
```
String name
```
      The name for the Amplify app.
    - tags
```
Map<K,V> tags
```
      The tag for the Amplify app.
    - description
```
String description
```
      The description for the Amplify app.
    - repository
```
String repository
```
      The Git repository for the Amplify app.
    - platform
```
String platform
```
      The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
    - createTime
```
Date createTime
```
      Creates a date and time for the Amplify app.
    - updateTime
```
Date updateTime
```
      Updates the date and time for the Amplify app.
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      The environment variables for the Amplify app.
      
      For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
    - defaultDomain
```
String defaultDomain
```
      The default domain for the Amplify app.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enables the auto-building of branches for the Amplify app.
    - enableBranchAutoDeletion
```
Boolean enableBranchAutoDeletion
```
      Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for the Amplify app's branches.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    - customRules
```
List<E> customRules
```
      Describes the custom redirect and rewrite rules for the Amplify app.
    - productionBranch
```
ProductionBranch productionBranch
```
      Describes the information about a production branch of the Amplify app.
    - buildSpec
```
String buildSpec
```
      Describes the content of the build specification (build spec) for the Amplify app.
    - customHeaders
```
String customHeaders
```
      Describes the custom HTTP headers for the Amplify app.
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for the Amplify app.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      Describes the automated branch creation glob patterns for the Amplify app.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      Describes the automated branch creation configuration for the Amplify app.
    - repositoryCloneMethod
```
String repositoryCloneMethod
```
      This is for internal use.
      
      The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
- Class com.amazonaws.services.amplify.model.Artifact extends Object implements Serializable
  - Serialized Fields
    - artifactFileName
```
String artifactFileName
```
      The file name for the artifact.
    - artifactId
```
String artifactId
```
      The unique ID for the artifact.
- Class com.amazonaws.services.amplify.model.AutoBranchCreationConfig extends Object implements Serializable
  - Serialized Fields
    - stage
```
String stage
```
      Describes the current stage for the autocreated branch.
    - framework
```
String framework
```
      The framework for the autocreated branch.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto building for the autocreated branch.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      The environment variables for the autocreated branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for the autocreated branch.
    - enablePerformanceMode
```
Boolean enablePerformanceMode
```
      Enables performance mode for the branch.
      
      Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) for the autocreated branch.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables pull request previews for the autocreated 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.Backend extends Object implements Serializable
  - Serialized Fields
    - stackArn
```
String stackArn
```
      The Amazon Resource Name (ARN) for the CloudFormation stack.
- Class com.amazonaws.services.amplify.model.BackendEnvironment extends Object implements Serializable
  - Serialized Fields
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    - environmentName
```
String environmentName
```
      The name for a backend environment that is part of an Amplify app.
    - stackName
```
String stackName
```
      The AWS CloudFormation stack name of a backend environment.
    - deploymentArtifacts
```
String deploymentArtifacts
```
      The name of deployment artifacts.
    - createTime
```
Date createTime
```
      The creation date and time for a backend environment that is part of an Amplify app.
    - updateTime
```
Date updateTime
```
      The last updated date and time for a backend environment that is 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
```
      The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    - branchName
```
String branchName
```
      The name for the branch that is part of an Amplify app.
    - description
```
String description
```
      The description for the branch that is part of an Amplify app.
    - tags
```
Map<K,V> tags
```
      The tag for the branch of an Amplify app.
    - stage
```
String stage
```
      The current stage for the branch that is part of an Amplify app.
    - displayName
```
String displayName
```
      The display name for the branch. This is used as the default domain prefix.
    - enableNotification
```
Boolean enableNotification
```
      Enables notifications for a branch that is part of an Amplify app.
    - createTime
```
Date createTime
```
      The creation date and time for a branch that is part of an Amplify app.
    - updateTime
```
Date updateTime
```
      The last updated date and time for a branch that is part of an Amplify app.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      The environment variables specific to a branch of an Amplify app.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto-building on push for a branch of an Amplify app.
    - customDomains
```
List<E> customDomains
```
      The custom domains for a branch of an Amplify app.
    - framework
```
String framework
```
      The framework for a branch of an Amplify app.
    - activeJobId
```
String activeJobId
```
      The ID of the active job for a branch of an Amplify app.
    - totalNumberOfJobs
```
String totalNumberOfJobs
```
      The total number of jobs that are part of an Amplify app.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for a branch of an Amplify app.
    - enablePerformanceMode
```
Boolean enablePerformanceMode
```
      Enables performance mode for the branch.
      
      Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    - thumbnailUrl
```
String thumbnailUrl
```
      The thumbnail URL for the branch of an Amplify app.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) content for the branch of an Amplify app.
    - ttl
```
String ttl
```
      The content Time to Live (TTL) for the website in seconds.
    - associatedResources
```
List<E> associatedResources
```
      A list of custom resources that are linked to this branch.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables pull request previews for the 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
```
      The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
      
      This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    - backend
```
Backend backend
```
- Class com.amazonaws.services.amplify.model.Certificate extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of SSL/TLS certificate that you want to use.
      
      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
      
      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide .
    - customCertificateArn
```
String customCertificateArn
```
      The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
      
      This field is required only when the certificate type is CUSTOM.
    - certificateVerificationDNSRecord
```
String certificateVerificationDNSRecord
```
      The DNS record for certificate verification.
- Class com.amazonaws.services.amplify.model.CertificateSettings extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The certificate type.
      
      Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions for you.
      
      Specify CUSTOM to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certificates into Certificate Manager in the ACM User guide.
    - customCertificateArn
```
String customCertificateArn
```
      The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.
      
      This field is required only when the certificate type is CUSTOM.
- Class com.amazonaws.services.amplify.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the Amplify app.
    - description
```
String description
```
      The description of the Amplify app.
    - repository
```
String repository
```
      The Git repository for the Amplify app.
    - platform
```
String platform
```
      The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      The AWS Identity and Access Management (IAM) service role for an Amplify app.
    - oauthToken
```
String oauthToken
```
      The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
      
      Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.
      
      You must specify either oauthToken or accessToken when you create a new app.
      
      Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    - accessToken
```
String accessToken
```
      The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
      
      Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.
      
      You must specify either accessToken or oauthToken when you create a new app.
      
      Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    - environmentVariables
```
Map<K,V> environmentVariables
```
      The environment variables map for an Amplify app.
      
      For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enables the auto building of branches for an Amplify app.
    - enableBranchAutoDeletion
```
Boolean enableBranchAutoDeletion
```
      Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    - customRules
```
List<E> customRules
```
      The custom rewrite and redirect rules for an Amplify app.
    - tags
```
Map<K,V> tags
```
      The tag for an Amplify app.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) for an Amplify app.
    - customHeaders
```
String customHeaders
```
      The custom HTTP headers for an Amplify app.
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for an Amplify app.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      The automated branch creation glob patterns for an Amplify app.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      The automated branch creation configuration for an 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
```
      The unique ID for an Amplify app.
    - environmentName
```
String environmentName
```
      The name for the backend environment.
    - stackName
```
String stackName
```
      The AWS CloudFormation stack name of a backend environment.
    - deploymentArtifacts
```
String deploymentArtifacts
```
      The name of deployment artifacts.
- Class com.amazonaws.services.amplify.model.CreateBackendEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironment
```
BackendEnvironment backendEnvironment
```
      Describes the backend environment for an Amplify app.
- Class com.amazonaws.services.amplify.model.CreateBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name for the branch.
    - description
```
String description
```
      The description for the branch.
    - stage
```
String stage
```
      Describes the current stage for the branch.
    - framework
```
String framework
```
      The 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
```
      The environment variables for the branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for the branch.
    - enablePerformanceMode
```
Boolean enablePerformanceMode
```
      Enables performance mode for the branch.
      
      Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    - tags
```
Map<K,V> tags
```
      The tag for the branch.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) for the branch.
    - ttl
```
String ttl
```
      The content Time To Live (TTL) for the website in seconds.
    - displayName
```
String displayName
```
      The display name for a branch. This is used as the default domain prefix.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables pull request previews for this branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify environment name for the pull request.
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
      
      This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
    - backend
```
Backend backend
```
      The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
      
      This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Class com.amazonaws.services.amplify.model.CreateBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      Describes the branch for an Amplify app, which maps to a third-party repository branch.
- Class com.amazonaws.services.amplify.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the job.
    - fileMap
```
Map<K,V> fileMap
```
      An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique 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 job ID for this deployment. will supply to start deployment api.
    - fileUploadUrls
```
Map<K,V> fileUploadUrls
```
      When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.
    - zipUploadUrl
```
String zipUploadUrl
```
      When the fileMap argument is not provided in the request, this zipUploadUrl is returned.
- Class com.amazonaws.services.amplify.model.CreateDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - domainName
```
String domainName
```
      The domain name for the domain association.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables the automated creation of subdomains for branches.
    - subDomainSettings
```
List<E> subDomainSettings
```
      The setting for the subdomain.
    - autoSubDomainCreationPatterns
```
List<E> autoSubDomainCreationPatterns
```
      Sets the branch patterns for automatic subdomain creation.
    - autoSubDomainIAMRole
```
String autoSubDomainIAMRole
```
      The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
    - certificateSettings
```
CertificateSettings certificateSettings
```
      The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
- Class com.amazonaws.services.amplify.model.CreateDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Describes the structure of a domain association, which associates a custom domain with an Amplify app.
- Class com.amazonaws.services.amplify.model.CreateWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name for a branch that is part of an Amplify app.
    - description
```
String description
```
      The description for a webhook.
- Class com.amazonaws.services.amplify.model.CreateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Describes a webhook that connects repository events to an Amplify app.
- 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.
      
      200
      
      Represents a 200 rewrite rule.
      
      301
      
      Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL.
      
      302
      
      Represents a 302 temporary redirect rule.
      
      404
      
      Represents a 404 redirect rule.
      
      404-200
      
      Represents a 404 rewrite rule.
    - condition
```
String condition
```
      The condition for a URL rewrite or redirect rule, such as a country code.
- Class com.amazonaws.services.amplify.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The 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
```
      The unique ID of an Amplify app.
    - environmentName
```
String environmentName
```
      The 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
```
      Describes the backend environment for an Amplify app.
- Class com.amazonaws.services.amplify.model.DeleteBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch.
- Class com.amazonaws.services.amplify.model.DeleteBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      The branch for an Amplify app, which maps to a third-party repository branch.
- Class com.amazonaws.services.amplify.model.DeleteDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique id for an Amplify app.
    - domainName
```
String domainName
```
      The 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
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the job.
    - jobId
```
String jobId
```
      The 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
```
      The unique ID for a webhook.
- Class com.amazonaws.services.amplify.model.DeleteWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Describes a webhook that connects repository events to an Amplify app.
- 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
```
      The Amazon Resource Name (ARN) for the domain association.
    - domainName
```
String domainName
```
      The name of the domain.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables the automated creation of subdomains for branches.
    - autoSubDomainCreationPatterns
```
List<E> autoSubDomainCreationPatterns
```
      Sets branch patterns for automatic subdomain creation.
    - autoSubDomainIAMRole
```
String autoSubDomainIAMRole
```
      The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
    - domainStatus
```
String domainStatus
```
      The current status of the domain association.
    - updateStatus
```
String updateStatus
```
      The status of the domain update operation that is currently in progress. The following list describes the valid update states.
      
      REQUESTING_CERTIFICATE
      
      The certificate is in the process of being updated.
      
      PENDING_VERIFICATION
      
      Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
      
      IMPORTING_CUSTOM_CERTIFICATE
      
      Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
      
      PENDING_DEPLOYMENT
      
      Indicates that the subdomain or certificate changes are being propagated.
      
      AWAITING_APP_CNAME
      
      Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide.
      
      UPDATE_COMPLETE
      
      The certificate has been associated with a domain.
      
      UPDATE_FAILED
      
      The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
    - statusReason
```
String statusReason
```
      Additional information that describes why the domain association is in the current state.
    - certificateVerificationDNSRecord
```
String certificateVerificationDNSRecord
```
      The DNS record for certificate verification.
    - subDomains
```
List<E> subDomains
```
      The subdomains for the domain association.
    - certificate
```
Certificate certificate
```
      Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.
      
      If you are updating your domain to use a different certificate, certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, certificate points to the current active certificate.
- Class com.amazonaws.services.amplify.model.GenerateAccessLogsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - startTime
```
Date startTime
```
      The time at which the logs should start. The time range specified is inclusive of the start time.
    - endTime
```
Date endTime
```
      The time at which the logs should end. The time range specified is inclusive of the end time.
    - domainName
```
String domainName
```
      The name of the domain.
    - appId
```
String appId
```
      The unique ID for an Amplify app.
- Class com.amazonaws.services.amplify.model.GenerateAccessLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - logUrl
```
String logUrl
```
      The pre-signed URL for the requested access logs.
- Class com.amazonaws.services.amplify.model.GetAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The 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
```
      The unique ID for an artifact.
- Class com.amazonaws.services.amplify.model.GetArtifactUrlResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - artifactId
```
String artifactId
```
      The unique ID for an artifact.
    - artifactUrl
```
String artifactUrl
```
      The presigned URL for the artifact.
- Class com.amazonaws.services.amplify.model.GetBackendEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique id for an Amplify app.
    - environmentName
```
String environmentName
```
      The name for the backend environment.
- Class com.amazonaws.services.amplify.model.GetBackendEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironment
```
BackendEnvironment backendEnvironment
```
      Describes the backend environment for an Amplify app.
- Class com.amazonaws.services.amplify.model.GetBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of 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
```
      The unique id for an Amplify app.
    - domainName
```
String domainName
```
      The name of the domain.
- Class com.amazonaws.services.amplify.model.GetDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Describes the structure of a domain association, which associates a custom domain with an Amplify app.
- Class com.amazonaws.services.amplify.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the job.
    - jobId
```
String jobId
```
      The 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
```
      The unique ID for a webhook.
- Class com.amazonaws.services.amplify.model.GetWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Describes the structure of a webhook.
- 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
```
      Describes the summary for an execution job for an Amplify app.
    - steps
```
List<E> steps
```
      The 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
```
      The Amazon Resource Name (ARN) for the job.
    - jobId
```
String jobId
```
      The unique ID for the job.
    - commitId
```
String commitId
```
      The commit ID from a third-party repository provider for the job.
    - commitMessage
```
String commitMessage
```
      The commit message from a third-party repository provider for the job.
    - commitTime
```
Date commitTime
```
      The commit date and time for the job.
    - startTime
```
Date startTime
```
      The start date and time for the job.
    - status
```
String status
```
      The current status for the job.
    - endTime
```
Date endTime
```
      The end date and time for the job.
    - jobType
```
String jobType
```
      The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was 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
```
      A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
    - maxResults
```
Integer maxResults
```
      The 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
```
      A list of Amplify apps.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. 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
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of a branch that is part of an Amplify app.
    - jobId
```
String jobId
```
      The unique ID for a job.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
    - maxResults
```
Integer maxResults
```
      The 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
```
      A list of artifacts.
    - nextToken
```
String nextToken
```
      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- Class com.amazonaws.services.amplify.model.ListBackendEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - environmentName
```
String environmentName
```
      The name of the backend environment
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.
    - maxResults
```
Integer maxResults
```
      The 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
```
      The list of backend environments for an Amplify app.
    - nextToken
```
String nextToken
```
      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- Class com.amazonaws.services.amplify.model.ListBranchesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.
    - maxResults
```
Integer maxResults
```
      The 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
```
      A list of branches for an Amplify app.
    - nextToken
```
String nextToken
```
      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- Class com.amazonaws.services.amplify.model.ListDomainAssociationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.
    - maxResults
```
Integer maxResults
```
      The 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
```
      A list of domain associations.
    - nextToken
```
String nextToken
```
      A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.
- Class com.amazonaws.services.amplify.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the request.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
    - maxResults
```
Integer maxResults
```
      The 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
```
      The result structure for the list job result request.
    - nextToken
```
String nextToken
```
      A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
- Class com.amazonaws.services.amplify.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) to use to list tags.
- Class com.amazonaws.services.amplify.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      A list of tags for the specified The Amazon Resource Name (ARN).
- Class com.amazonaws.services.amplify.model.ListWebhooksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - nextToken
```
String nextToken
```
      A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.
    - maxResults
```
Integer maxResults
```
      The 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
```
      A list of webhooks.
    - nextToken
```
String nextToken
```
      A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve 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
```
      The last deploy time of the production branch.
    - status
```
String status
```
      The status of the production branch.
    - thumbnailUrl
```
String thumbnailUrl
```
      The thumbnail URL for the production branch.
    - branchName
```
String branchName
```
      The branch name for the 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
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the job.
    - jobId
```
String jobId
```
      The job ID for this deployment, generated by the create deployment request.
    - sourceUrl
```
String sourceUrl
```
      The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.
- Class com.amazonaws.services.amplify.model.StartDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      The summary for the job.
- Class com.amazonaws.services.amplify.model.StartJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the job.
    - jobId
```
String jobId
```
      The unique ID for an existing job. This is required if the value of jobType is RETRY.
    - jobType
```
String jobType
```
      Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.
      
      The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
    - jobReason
```
String jobReason
```
      A descriptive reason for starting the job.
    - commitId
```
String commitId
```
      The commit ID from a third-party repository provider for the job.
    - commitMessage
```
String commitMessage
```
      The commit message from a third-party repository provider for the job.
    - commitTime
```
Date commitTime
```
      The commit date and time for the job.
- Class com.amazonaws.services.amplify.model.StartJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      The summary for the job.
- Class com.amazonaws.services.amplify.model.Step extends Object implements Serializable
  - Serialized Fields
    - stepName
```
String stepName
```
      The name of the execution step.
    - startTime
```
Date startTime
```
      The start date and time of the execution step.
    - status
```
String status
```
      The status of the execution step.
    - endTime
```
Date endTime
```
      The end date and time of the execution step.
    - logUrl
```
String logUrl
```
      The URL to the logs for the execution step.
    - artifactsUrl
```
String artifactsUrl
```
      The URL to the artifact for the execution step.
    - testArtifactsUrl
```
String testArtifactsUrl
```
      The URL to the test artifact for the execution step.
    - testConfigUrl
```
String testConfigUrl
```
      The URL to the test configuration for the execution step.
    - screenshots
```
Map<K,V> screenshots
```
      The list of screenshot URLs for the execution step, if relevant.
    - statusReason
```
String statusReason
```
      The reason for the current step status.
    - context
```
String context
```
      The context for the current step. Includes a build image if the step is build.
- Class com.amazonaws.services.amplify.model.StopJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch to use for the stop job request.
    - jobId
```
String jobId
```
      The unique id for the job.
- Class com.amazonaws.services.amplify.model.StopJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      The summary for the job.
- Class com.amazonaws.services.amplify.model.SubDomain extends Object implements Serializable
  - Serialized Fields
    - subDomainSetting
```
SubDomainSetting subDomainSetting
```
      Describes the settings for the subdomain.
    - verified
```
Boolean verified
```
      The verified status of the subdomain
    - dnsRecord
```
String dnsRecord
```
      The DNS record for the subdomain.
- Class com.amazonaws.services.amplify.model.SubDomainSetting extends Object implements Serializable
  - Serialized Fields
    - prefix
```
String prefix
```
      The prefix setting for the subdomain.
    - branchName
```
String branchName
```
      The branch name setting for the subdomain.
- Class com.amazonaws.services.amplify.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) to use to tag a resource.
    - tags
```
Map<K,V> tags
```
      The tags used to tag the 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
```
      The Amazon Resource Name (ARN) to use to untag a resource.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys to use to untag a 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
```
      The unique ID for an Amplify app.
    - name
```
String name
```
      The name for an Amplify app.
    - description
```
String description
```
      The description for an Amplify app.
    - platform
```
String platform
```
      The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      The AWS Identity and Access Management (IAM) service role for an Amplify app.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      The environment variables for an Amplify app.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enables branch auto-building for an Amplify app.
    - enableBranchAutoDeletion
```
Boolean enableBranchAutoDeletion
```
      Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for an Amplify app.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    - customRules
```
List<E> customRules
```
      The custom redirect and rewrite rules for an Amplify app.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) for an Amplify app.
    - customHeaders
```
String customHeaders
```
      The custom HTTP headers for an Amplify app.
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for an Amplify app.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      Describes the automated branch creation glob patterns for an Amplify app.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      The automated branch creation configuration for an Amplify app.
    - repository
```
String repository
```
      The name of the Git repository for an Amplify app.
    - oauthToken
```
String oauthToken
```
      The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
      
      Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.
      
      To authorize access to GitHub as your repository provider, use accessToken.
      
      You must specify either oauthToken or accessToken when you update an app.
      
      Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
    - accessToken
```
String accessToken
```
      The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
      
      Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.
      
      You must specify either accessToken or oauthToken when you update an app.
      
      Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
- Class com.amazonaws.services.amplify.model.UpdateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - app
```
App app
```
      Represents the updated Amplify app.
- Class com.amazonaws.services.amplify.model.UpdateBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - branchName
```
String branchName
```
      The name of the branch.
    - description
```
String description
```
      The description for the branch.
    - framework
```
String framework
```
      The framework for the branch.
    - stage
```
String stage
```
      Describes the current 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
```
      The environment variables for the branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables basic authorization for the branch.
    - enablePerformanceMode
```
Boolean enablePerformanceMode
```
      Enables performance mode for the branch.
      
      Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    - buildSpec
```
String buildSpec
```
      The build specification (build spec) for the branch.
    - ttl
```
String ttl
```
      The content Time to Live (TTL) for the website in seconds.
    - displayName
```
String displayName
```
      The display name for a branch. This is used as the default domain prefix.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables pull request previews for this branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify environment name for the pull request.
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.
      
      This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
    - backend
```
Backend backend
```
      The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
      
      This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Class com.amazonaws.services.amplify.model.UpdateBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      The branch for an Amplify app, which maps to a third-party repository branch.
- Class com.amazonaws.services.amplify.model.UpdateDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID for an Amplify app.
    - domainName
```
String domainName
```
      The name of the domain.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables the automated creation of subdomains for branches.
    - subDomainSettings
```
List<E> subDomainSettings
```
      Describes the settings for the subdomain.
    - autoSubDomainCreationPatterns
```
List<E> autoSubDomainCreationPatterns
```
      Sets the branch patterns for automatic subdomain creation.
    - autoSubDomainIAMRole
```
String autoSubDomainIAMRole
```
      The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
    - certificateSettings
```
CertificateSettings certificateSettings
```
      The type of SSL/TLS certificate to use for your custom domain.
- Class com.amazonaws.services.amplify.model.UpdateDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Describes a domain association, which associates a custom domain with an Amplify app.
- Class com.amazonaws.services.amplify.model.UpdateWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - webhookId
```
String webhookId
```
      The unique ID for a webhook.
    - branchName
```
String branchName
```
      The name for a branch that is part of an Amplify app.
    - description
```
String description
```
      The description for a webhook.
- Class com.amazonaws.services.amplify.model.UpdateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Describes a webhook that connects repository events to an Amplify app.
- Class com.amazonaws.services.amplify.model.Webhook extends Object implements Serializable
  - Serialized Fields
    - webhookArn
```
String webhookArn
```
      The Amazon Resource Name (ARN) for the webhook.
    - webhookId
```
String webhookId
```
      The ID of the webhook.
    - webhookUrl
```
String webhookUrl
```
      The URL of the webhook.
    - branchName
```
String branchName
```
      The name for a branch that is part of an Amplify app.
    - description
```
String description
```
      The description for a webhook.
    - createTime
```
Date createTime
```
      The create date and time for a webhook.
    - updateTime
```
Date updateTime
```
      Updates the date and time for a webhook.
Package com.amazonaws.services.amplifybackend.model
- Class com.amazonaws.services.amplifybackend.model.AWSAmplifyBackendException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplifybackend.model.BackendAPIAppSyncAuthSettings extends Object implements Serializable
  - Serialized Fields
    - cognitoUserPoolId
```
String cognitoUserPoolId
```
      The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
    - description
```
String description
```
      The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
    - expirationTime
```
Double expirationTime
```
      The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
    - openIDAuthTTL
```
String openIDAuthTTL
```
      The expiry time for the OpenID authentication mechanism.
    - openIDClientId
```
String openIDClientId
```
      The clientID for openID, if openID was used as an authentication setting to access your data models.
    - openIDIatTTL
```
String openIDIatTTL
```
      The expiry time for the OpenID authentication mechanism.
    - openIDIssueURL
```
String openIDIssueURL
```
      The openID issuer URL, if openID was used as an authentication setting to access your data models.
    - openIDProviderName
```
String openIDProviderName
```
      The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
- Class com.amazonaws.services.amplifybackend.model.BackendAPIAuthType extends Object implements Serializable
  - Serialized Fields
    - mode
```
String mode
```
      Describes the authentication mode.
    - settings
```
BackendAPIAppSyncAuthSettings settings
```
      Describes settings for the authentication mode.
- Class com.amazonaws.services.amplifybackend.model.BackendAPIConflictResolution extends Object implements Serializable
  - Serialized Fields
    - resolutionStrategy
```
String resolutionStrategy
```
      The strategy for conflict resolution.
- Class com.amazonaws.services.amplifybackend.model.BackendAPIResourceConfig extends Object implements Serializable
  - Serialized Fields
    - additionalAuthTypes
```
List<E> additionalAuthTypes
```
      Additional authentication methods used to interact with your data models.
    - apiName
```
String apiName
```
      The API name used to interact with the data model, configured as a part of your Amplify project.
    - conflictResolution
```
BackendAPIConflictResolution conflictResolution
```
      The conflict resolution strategy for your data stored in the data models.
    - defaultAuthType
```
BackendAPIAuthType defaultAuthType
```
      The default authentication type for interacting with the configured data models in your Amplify project.
    - service
```
String service
```
      The service used to provision and interact with the data model.
    - transformSchema
```
String transformSchema
```
      The definition of the data model in the annotated transform of the GraphQL schema.
- Class com.amazonaws.services.amplifybackend.model.BackendAuthAppleProviderConfig extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      Describes the client_id (also called Services ID) that comes from Apple.
    - keyId
```
String keyId
```
      Describes the key_id that comes from Apple.
    - privateKey
```
String privateKey
```
      Describes the private_key that comes from Apple.
    - teamId
```
String teamId
```
      Describes the team_id that comes from Apple.
- Class com.amazonaws.services.amplifybackend.model.BackendAuthSocialProviderConfig extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      Describes the client_id, which can be obtained from the third-party social federation provider.
    - clientSecret
```
String clientSecret
```
      Describes the client_secret, which can be obtained from third-party social federation providers.
- Class com.amazonaws.services.amplifybackend.model.BackendJobRespObj extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - createTime
```
String createTime
```
      The time when the job was created.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
    - updateTime
```
String updateTime
```
      The time when the job was last updated.
- Class com.amazonaws.services.amplifybackend.model.BackendStoragePermissions extends Object implements Serializable
  - Serialized Fields
    - authenticated
```
List<E> authenticated
```
      Lists all authenticated user read, write, and delete permissions for your S3 bucket.
    - unAuthenticated
```
List<E> unAuthenticated
```
      Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
- Class com.amazonaws.services.amplifybackend.model.BadRequestException extends AWSAmplifyBackendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplifybackend.model.CloneBackendRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - targetEnvironmentName
```
String targetEnvironmentName
```
      The name of the destination backend environment to be created.
- Class com.amazonaws.services.amplifybackend.model.CloneBackendResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAPIRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
BackendAPIResourceConfig resourceConfig
```
      The resource configuration for this request.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAPIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthForgotPasswordConfig extends Object implements Serializable
  - Serialized Fields
    - deliveryMethod
```
String deliveryMethod
```
      (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
    - emailSettings
```
EmailSettings emailSettings
```
      (DEPRECATED) The configuration for the email sent when an app user forgets their password.
    - smsSettings
```
SmsSettings smsSettings
```
      (DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthIdentityPoolConfig extends Object implements Serializable
  - Serialized Fields
    - identityPoolName
```
String identityPoolName
```
      Name of the Amazon Cognito identity pool used for authorization.
    - unauthenticatedLogin
```
Boolean unauthenticatedLogin
```
      Set to true or false based on whether you want to enable guest authorization to your Amplify app.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthMFAConfig extends Object implements Serializable
  - Serialized Fields
    - mFAMode
```
String mFAMode
```
      Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
    - settings
```
Settings settings
```
      Describes the configuration settings and methods for your Amplify app users to use MFA.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthOAuthConfig extends Object implements Serializable
  - Serialized Fields
    - domainPrefix
```
String domainPrefix
```
      The domain prefix for your Amplify app.
    - oAuthGrantType
```
String oAuthGrantType
```
      The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
    - oAuthScopes
```
List<E> oAuthScopes
```
      List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
    - redirectSignInURIs
```
List<E> redirectSignInURIs
```
      The redirected URI for signing in to your Amplify app.
    - redirectSignOutURIs
```
List<E> redirectSignOutURIs
```
      Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    - socialProviderSettings
```
SocialProviderSettings socialProviderSettings
```
      The settings for using social providers to access your Amplify app.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthPasswordPolicyConfig extends Object implements Serializable
  - Serialized Fields
    - additionalConstraints
```
List<E> additionalConstraints
```
      Additional constraints for the password used to access the backend of your Amplify project.
    - minimumLength
```
Double minimumLength
```
      The minimum length of the password used to access the backend of your Amplify project.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
CreateBackendAuthResourceConfig resourceConfig
```
      The resource configuration for this request object.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthResourceConfig extends Object implements Serializable
  - Serialized Fields
    - authResources
```
String authResources
```
      Defines whether you want to configure only authentication or both authentication and authorization settings.
    - identityPoolConfigs
```
CreateBackendAuthIdentityPoolConfig identityPoolConfigs
```
      Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
    - service
```
String service
```
      Defines the service name to use when configuring an authentication resource in your Amplify project.
    - userPoolConfigs
```
CreateBackendAuthUserPoolConfig userPoolConfigs
```
      Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthUserPoolConfig extends Object implements Serializable
  - Serialized Fields
    - forgotPassword
```
CreateBackendAuthForgotPasswordConfig forgotPassword
```
      (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - mfa
```
CreateBackendAuthMFAConfig mfa
```
      Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    - oAuth
```
CreateBackendAuthOAuthConfig oAuth
```
      Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - passwordPolicy
```
CreateBackendAuthPasswordPolicyConfig passwordPolicy
```
      Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - requiredSignUpAttributes
```
List<E> requiredSignUpAttributes
```
      The required attributes to sign up new users in the user pool.
    - signInMethod
```
String signInMethod
```
      Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
    - userPoolName
```
String userPoolName
```
      The Amazon Cognito user pool name.
    - verificationMessage
```
CreateBackendAuthVerificationMessageConfig verificationMessage
```
      Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendAuthVerificationMessageConfig extends Object implements Serializable
  - Serialized Fields
    - deliveryMethod
```
String deliveryMethod
```
      The type of verification message to send.
    - emailSettings
```
EmailSettings emailSettings
```
      The settings for the email message.
    - smsSettings
```
SmsSettings smsSettings
```
      The settings for the SMS message.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendManagerAppId
```
String backendManagerAppId
```
      The app ID for the backend manager.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - appName
```
String appName
```
      The name of the app.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
ResourceConfig resourceConfig
```
      The resource configuration for creating a backend.
    - resourceName
```
String resourceName
```
      The name of the resource.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendStorageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
CreateBackendStorageResourceConfig resourceConfig
```
      The resource configuration for creating backend storage.
    - resourceName
```
String resourceName
```
      The name of the storage resource.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendStorageResourceConfig extends Object implements Serializable
  - Serialized Fields
    - bucketName
```
String bucketName
```
      The name of the S3 bucket.
    - permissions
```
BackendStoragePermissions permissions
```
      The authorization configuration for the storage S3 bucket.
    - serviceName
```
String serviceName
```
      The name of the storage service.
- Class com.amazonaws.services.amplifybackend.model.CreateBackendStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.CreateTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
- Class com.amazonaws.services.amplifybackend.model.CreateTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - challengeCode
```
String challengeCode
```
      One-time challenge code for authenticating into the Amplify Admin UI.
    - sessionId
```
String sessionId
```
      A unique ID provided when creating a new challenge token.
    - ttl
```
String ttl
```
      The expiry time for the one-time generated token code.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendAPIRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
BackendAPIResourceConfig resourceConfig
```
      Defines the resource configuration for the data model in your Amplify project.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendAPIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendStorageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of the storage resource.
    - serviceName
```
String serviceName
```
      The name of the storage service.
- Class com.amazonaws.services.amplifybackend.model.DeleteBackendStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.DeleteTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - sessionId
```
String sessionId
```
      The session ID.
- Class com.amazonaws.services.amplifybackend.model.DeleteTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - isSuccess
```
Boolean isSuccess
```
      Indicates whether the request succeeded or failed.
- Class com.amazonaws.services.amplifybackend.model.EmailSettings extends Object implements Serializable
  - Serialized Fields
    - emailMessage
```
String emailMessage
```
      The contents of the email message.
    - emailSubject
```
String emailSubject
```
      The contents of the subject line of the email message.
- Class com.amazonaws.services.amplifybackend.model.GatewayTimeoutException extends AWSAmplifyBackendException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplifybackend.model.GenerateBackendAPIModelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GenerateBackendAPIModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAPIModelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAPIModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - models
```
String models
```
      Stringified JSON of the datastore model.
    - status
```
String status
```
      The current status of the request.
    - modelIntrospectionSchema
```
String modelIntrospectionSchema
```
      Stringified JSON of the model introspection schema for an existing backend API resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAPIRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
BackendAPIResourceConfig resourceConfig
```
      Defines the resource configuration for the data model in your Amplify project.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAPIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - resourceConfig
```
BackendAPIResourceConfig resourceConfig
```
      The resource configuration for this response object.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - resourceConfig
```
CreateBackendAuthResourceConfig resourceConfig
```
      The resource configuration for authorization requests to the backend of your Amplify project.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
- Class com.amazonaws.services.amplifybackend.model.GetBackendJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - createTime
```
String createTime
```
      The time when the job was created.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
    - updateTime
```
String updateTime
```
      The time when the job was last updated.
- Class com.amazonaws.services.amplifybackend.model.GetBackendRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
- Class com.amazonaws.services.amplifybackend.model.GetBackendResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - amplifyFeatureFlags
```
String amplifyFeatureFlags
```
      A stringified version of the cli.json file for your Amplify project.
    - amplifyMetaConfig
```
String amplifyMetaConfig
```
      A stringified version of the current configs for your Amplify project.
    - appId
```
String appId
```
      The app ID.
    - appName
```
String appName
```
      The name of the app.
    - backendEnvironmentList
```
List<E> backendEnvironmentList
```
      A list of backend environments in an array.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request failed, this is the returned error.
- Class com.amazonaws.services.amplifybackend.model.GetBackendStorageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceName
```
String resourceName
```
      The name of the storage resource.
- Class com.amazonaws.services.amplifybackend.model.GetBackendStorageResourceConfig extends Object implements Serializable
  - Serialized Fields
    - bucketName
```
String bucketName
```
      The name of the S3 bucket.
    - imported
```
Boolean imported
```
      Returns True if the storage resource has been imported.
    - permissions
```
BackendStoragePermissions permissions
```
      The authorization configuration for the storage S3 bucket.
    - serviceName
```
String serviceName
```
      The name of the storage service.
- Class com.amazonaws.services.amplifybackend.model.GetBackendStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
GetBackendStorageResourceConfig resourceConfig
```
      The resource configuration for the backend storage resource.
    - resourceName
```
String resourceName
```
      The name of the storage resource.
- Class com.amazonaws.services.amplifybackend.model.GetTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - sessionId
```
String sessionId
```
      The session ID.
- Class com.amazonaws.services.amplifybackend.model.GetTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - challengeCode
```
String challengeCode
```
      The one-time challenge code for authenticating into the Amplify Admin UI.
    - sessionId
```
String sessionId
```
      A unique ID provided when creating a new challenge token.
    - ttl
```
String ttl
```
      The expiry time for the one-time generated token code.
- Class com.amazonaws.services.amplifybackend.model.ImportBackendAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - identityPoolId
```
String identityPoolId
```
      The ID of the Amazon Cognito identity pool.
    - nativeClientId
```
String nativeClientId
```
      The ID of the Amazon Cognito native client.
    - userPoolId
```
String userPoolId
```
      The ID of the Amazon Cognito user pool.
    - webClientId
```
String webClientId
```
      The ID of the Amazon Cognito web client.
- Class com.amazonaws.services.amplifybackend.model.ImportBackendAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.ImportBackendStorageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - bucketName
```
String bucketName
```
      The name of the S3 bucket.
    - serviceName
```
String serviceName
```
      The name of the storage service.
- Class com.amazonaws.services.amplifybackend.model.ImportBackendStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.ListBackendJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - maxResults
```
Integer maxResults
```
      The maximum number of results that you want in the response.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - operation
```
String operation
```
      Filters the list of response objects to include only those with the specified operation name.
    - status
```
String status
```
      Filters the list of response objects to include only those with the specified status.
- Class com.amazonaws.services.amplifybackend.model.ListBackendJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      An array of jobs and their properties.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.amplifybackend.model.ListS3BucketsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.amplifybackend.model.ListS3BucketsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - buckets
```
List<E> buckets
```
      The list of S3 buckets.
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.amplifybackend.model.LoginAuthConfigReqObj extends Object implements Serializable
  - Serialized Fields
    - awsCognitoIdentityPoolId
```
String awsCognitoIdentityPoolId
```
      The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
    - awsCognitoRegion
```
String awsCognitoRegion
```
      The AWS Region for the Amplify Admin UI login.
    - awsUserPoolsId
```
String awsUserPoolsId
```
      The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
    - awsUserPoolsWebClientId
```
String awsUserPoolsWebClientId
```
      The web client ID for the Amazon Cognito user pools.
- Class com.amazonaws.services.amplifybackend.model.NotFoundException extends AWSAmplifyBackendException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of resource that is not found.
- Class com.amazonaws.services.amplifybackend.model.RemoveAllBackendsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - cleanAmplifyApp
```
Boolean cleanAmplifyApp
```
      Cleans up the Amplify Console app if this value is set to true.
- Class com.amazonaws.services.amplifybackend.model.RemoveAllBackendsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.RemoveBackendConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
- Class com.amazonaws.services.amplifybackend.model.RemoveBackendConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - error
```
String error
```
      If the request fails, this error is returned.
- Class com.amazonaws.services.amplifybackend.model.ResourceConfig extends Object implements Serializable
- Class com.amazonaws.services.amplifybackend.model.S3BucketInfo extends Object implements Serializable
  - Serialized Fields
    - creationDate
```
String creationDate
```
      The creation date of the S3 bucket.
    - name
```
String name
```
      The name of the S3 bucket.
- Class com.amazonaws.services.amplifybackend.model.Settings extends Object implements Serializable
  - Serialized Fields
    - mfaTypes
```
List<E> mfaTypes
```
      The supported MFA types.
    - smsMessage
```
String smsMessage
```
      The body of the SMS message.
- Class com.amazonaws.services.amplifybackend.model.SmsSettings extends Object implements Serializable
  - Serialized Fields
    - smsMessage
```
String smsMessage
```
      The contents of the SMS message.
- Class com.amazonaws.services.amplifybackend.model.SocialProviderSettings extends Object implements Serializable
  - Serialized Fields
    - facebook
```
BackendAuthSocialProviderConfig facebook
```
    - google
```
BackendAuthSocialProviderConfig google
```
    - loginWithAmazon
```
BackendAuthSocialProviderConfig loginWithAmazon
```
    - signInWithApple
```
BackendAuthAppleProviderConfig signInWithApple
```
- Class com.amazonaws.services.amplifybackend.model.TooManyRequestsException extends AWSAmplifyBackendException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - limitType
```
String limitType
```
      The type of limit that was exceeded.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAPIRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
BackendAPIResourceConfig resourceConfig
```
      Defines the resource configuration for the data model in your Amplify project.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAPIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthForgotPasswordConfig extends Object implements Serializable
  - Serialized Fields
    - deliveryMethod
```
String deliveryMethod
```
      (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
    - emailSettings
```
EmailSettings emailSettings
```
      (DEPRECATED) The configuration for the email sent when an app user forgets their password.
    - smsSettings
```
SmsSettings smsSettings
```
      (DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthIdentityPoolConfig extends Object implements Serializable
  - Serialized Fields
    - unauthenticatedLogin
```
Boolean unauthenticatedLogin
```
      A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthMFAConfig extends Object implements Serializable
  - Serialized Fields
    - mFAMode
```
String mFAMode
```
      The MFA mode for the backend of your Amplify project.
    - settings
```
Settings settings
```
      The settings of your MFA configuration for the backend of your Amplify project.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthOAuthConfig extends Object implements Serializable
  - Serialized Fields
    - domainPrefix
```
String domainPrefix
```
      The Amazon Cognito domain prefix used to create a hosted UI for authentication.
    - oAuthGrantType
```
String oAuthGrantType
```
      The OAuth grant type to allow app users to authenticate from your Amplify app.
    - oAuthScopes
```
List<E> oAuthScopes
```
      The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
    - redirectSignInURIs
```
List<E> redirectSignInURIs
```
      Redirect URLs that OAuth uses when a user signs in to an Amplify app.
    - redirectSignOutURIs
```
List<E> redirectSignOutURIs
```
      Redirect URLs that OAuth uses when a user signs out of an Amplify app.
    - socialProviderSettings
```
SocialProviderSettings socialProviderSettings
```
      Describes third-party social federation configurations for allowing your users to sign in with OAuth.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthPasswordPolicyConfig extends Object implements Serializable
  - Serialized Fields
    - additionalConstraints
```
List<E> additionalConstraints
```
      Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
    - minimumLength
```
Double minimumLength
```
      Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
UpdateBackendAuthResourceConfig resourceConfig
```
      The resource configuration for this request object.
    - resourceName
```
String resourceName
```
      The name of this resource.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthResourceConfig extends Object implements Serializable
  - Serialized Fields
    - authResources
```
String authResources
```
      Defines the service name to use when configuring an authentication resource in your Amplify project.
    - identityPoolConfigs
```
UpdateBackendAuthIdentityPoolConfig identityPoolConfigs
```
      Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
    - service
```
String service
```
      Defines the service name to use when configuring an authentication resource in your Amplify project.
    - userPoolConfigs
```
UpdateBackendAuthUserPoolConfig userPoolConfigs
```
      Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthUserPoolConfig extends Object implements Serializable
  - Serialized Fields
    - forgotPassword
```
UpdateBackendAuthForgotPasswordConfig forgotPassword
```
      (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - mfa
```
UpdateBackendAuthMFAConfig mfa
```
      Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
    - oAuth
```
UpdateBackendAuthOAuthConfig oAuth
```
      Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - passwordPolicy
```
UpdateBackendAuthPasswordPolicyConfig passwordPolicy
```
      Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
    - verificationMessage
```
UpdateBackendAuthVerificationMessageConfig verificationMessage
```
      Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendAuthVerificationMessageConfig extends Object implements Serializable
  - Serialized Fields
    - deliveryMethod
```
String deliveryMethod
```
      The type of verification message to send.
    - emailSettings
```
EmailSettings emailSettings
```
      The settings for the email message.
    - smsSettings
```
SmsSettings smsSettings
```
      The settings for the SMS message.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - loginAuthConfig
```
LoginAuthConfigReqObj loginAuthConfig
```
      Describes the Amazon Cognito configuration for Admin UI access.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendManagerAppId
```
String backendManagerAppId
```
      The app ID for the backend manager.
    - error
```
String error
```
      If the request fails, this error is returned.
    - loginAuthConfig
```
LoginAuthConfigReqObj loginAuthConfig
```
      Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      Filters the list of response objects to include only those with the specified operation name.
    - status
```
String status
```
      Filters the list of response objects to include only those with the specified status.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - createTime
```
String createTime
```
      The time when the job was created.
    - error
```
String error
```
      If the request fails, this error is returned.
    - jobId
```
String jobId
```
      The ID for the job.
    - operation
```
String operation
```
      The name of the operation.
    - status
```
String status
```
      The current status of the request.
    - updateTime
```
String updateTime
```
      The time when the job was last updated.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendStorageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - resourceConfig
```
UpdateBackendStorageResourceConfig resourceConfig
```
      The resource configuration for updating backend storage.
    - resourceName
```
String resourceName
```
      The name of the storage resource.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendStorageResourceConfig extends Object implements Serializable
  - Serialized Fields
    - permissions
```
BackendStoragePermissions permissions
```
      The authorization configuration for the storage S3 bucket.
    - serviceName
```
String serviceName
```
      The name of the storage service.
- Class com.amazonaws.services.amplifybackend.model.UpdateBackendStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The app ID.
    - backendEnvironmentName
```
String backendEnvironmentName
```
      The name of the backend environment.
    - jobId
```
String jobId
```
      The ID for the job.
    - status
```
String status
```
      The current status of the request.
Package com.amazonaws.services.amplifyuibuilder.model
- Class com.amazonaws.services.amplifyuibuilder.model.ActionParameters extends Object implements Serializable
  - Serialized Fields
    - type
```
ComponentProperty type
```
      The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    - url
```
ComponentProperty url
```
      The URL to the location to open. Specify this value for a navigation action.
    - anchor
```
ComponentProperty anchor
```
      The HTML anchor link to the location to open. Specify this value for a navigation action.
    - target
```
ComponentProperty target
```
      The element within the same component to modify when the action occurs.
    - global
```
ComponentProperty global
```
      Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
    - model
```
String model
```
      The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
    - id
```
ComponentProperty id
```
      The unique ID of the component that the ActionParameters apply to.
    - fields
```
Map<K,V> fields
```
      A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
    - state
```
MutationActionSetStateParameter state
```
      A key-value pair that specifies the state property name and its initial value.
- Class com.amazonaws.services.amplifyuibuilder.model.ApiConfiguration extends Object implements Serializable
  - Serialized Fields
    - graphQLConfig
```
GraphQLRenderConfig graphQLConfig
```
      The configuration for an application using GraphQL APIs.
    - dataStoreConfig
```
DataStoreRenderConfig dataStoreConfig
```
      The configuration for an application using DataStore APIs.
    - noApiConfig
```
NoApiRenderConfig noApiConfig
```
      The configuration for an application with no API being used.
- Class com.amazonaws.services.amplifyuibuilder.model.AWSAmplifyUIBuilderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenDependency extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Name of the dependency package.
    - supportedVersion
```
String supportedVersion
```
      Indicates the version of the supported dependency package.
    - isSemVer
```
Boolean isSemVer
```
      Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.
    - reason
```
String reason
```
      Indicates the reason to include the dependency package in your project code.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenFeatureFlags extends Object implements Serializable
  - Serialized Fields
    - isRelationshipSupported
```
Boolean isRelationshipSupported
```
      Specifes whether a code generation job supports data relationships.
    - isNonModelSupported
```
Boolean isNonModelSupported
```
      Specifies whether a code generation job supports non models.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenGenericDataEnum extends Object implements Serializable
  - Serialized Fields
    - values
```
List<E> values
```
      The list of enum values in the generic data schema.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenGenericDataField extends Object implements Serializable
  - Serialized Fields
    - dataType
```
String dataType
```
      The data type for the generic data field.
    - dataTypeValue
```
String dataTypeValue
```
      The value of the data type for the generic data field.
    - required
```
Boolean required
```
      Specifies whether the generic data field is required.
    - readOnly
```
Boolean readOnly
```
      Specifies whether the generic data field is read-only.
    - isArray
```
Boolean isArray
```
      Specifies whether the generic data field is an array.
    - relationship
```
CodegenGenericDataRelationshipType relationship
```
      The relationship of the generic data schema.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenGenericDataModel extends Object implements Serializable
  - Serialized Fields
    - fields
```
Map<K,V> fields
```
      The fields in the generic data model.
    - isJoinTable
```
Boolean isJoinTable
```
      Specifies whether the generic data model is a join table.
    - primaryKeys
```
List<E> primaryKeys
```
      The primary keys of the generic data model.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenGenericDataNonModel extends Object implements Serializable
  - Serialized Fields
    - fields
```
Map<K,V> fields
```
      The fields in a generic data schema non model.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenGenericDataRelationshipType extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The data relationship type.
    - relatedModelName
```
String relatedModelName
```
      The name of the related model in the data relationship.
    - relatedModelFields
```
List<E> relatedModelFields
```
      The related model fields in the data relationship.
    - canUnlinkAssociatedModel
```
Boolean canUnlinkAssociatedModel
```
      Specifies whether the relationship can unlink the associated model.
    - relatedJoinFieldName
```
String relatedJoinFieldName
```
      The name of the related join field in the data relationship.
    - relatedJoinTableName
```
String relatedJoinTableName
```
      The name of the related join table in the data relationship.
    - belongsToFieldOnRelatedModel
```
String belongsToFieldOnRelatedModel
```
      The value of the belongsTo field on the related data model.
    - associatedFields
```
List<E> associatedFields
```
      The associated fields of the data relationship.
    - isHasManyIndex
```
Boolean isHasManyIndex
```
      Specifies whether the @index directive is supported for a hasMany data relationship.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenJob extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID for the code generation job.
    - appId
```
String appId
```
      The ID of the Amplify app associated with the code generation job.
    - environmentName
```
String environmentName
```
      The name of the backend environment associated with the code generation job.
    - renderConfig
```
CodegenJobRenderConfig renderConfig
```
    - genericDataSchema
```
CodegenJobGenericDataSchema genericDataSchema
```
    - autoGenerateForms
```
Boolean autoGenerateForms
```
      Specifies whether to autogenerate forms in the code generation job.
    - features
```
CodegenFeatureFlags features
```
    - status
```
String status
```
      The status of the code generation job.
    - statusMessage
```
String statusMessage
```
      The customized status message for the code generation job.
    - asset
```
CodegenJobAsset asset
```
      The CodegenJobAsset to use for the code generation job.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the code generation job.
    - createdAt
```
Date createdAt
```
      The time that the code generation job was created.
    - modifiedAt
```
Date modifiedAt
```
      The time that the code generation job was modified.
    - dependencies
```
List<E> dependencies
```
      Lists the dependency packages that may be required for the project code to run.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenJobAsset extends Object implements Serializable
  - Serialized Fields
    - downloadUrl
```
String downloadUrl
```
      The URL to use to access the asset.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenJobGenericDataSchema extends Object implements Serializable
  - Serialized Fields
    - dataSourceType
```
String dataSourceType
```
      The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.
    - models
```
Map<K,V> models
```
      The name of a CodegenGenericDataModel.
    - enums
```
Map<K,V> enums
```
      The name of a CodegenGenericDataEnum.
    - nonModels
```
Map<K,V> nonModels
```
      The name of a CodegenGenericDataNonModel.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenJobRenderConfig extends Object implements Serializable
  - Serialized Fields
    - react
```
ReactStartCodegenJobData react
```
      The name of the ReactStartCodegenJobData object.
- Class com.amazonaws.services.amplifyuibuilder.model.CodegenJobSummary extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the code generation job.
    - environmentName
```
String environmentName
```
      The name of the backend environment associated with the code generation job.
    - id
```
String id
```
      The unique ID for the code generation job summary.
    - createdAt
```
Date createdAt
```
      The time that the code generation job summary was created.
    - modifiedAt
```
Date modifiedAt
```
      The time that the code generation job summary was modified.
- Class com.amazonaws.services.amplifyuibuilder.model.Component extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - sourceId
```
String sourceId
```
      The unique ID of the component in its original source system, such as Figma.
    - id
```
String id
```
      The unique ID of the component.
    - name
```
String name
```
      The name of the component.
    - componentType
```
String componentType
```
      The type of the component. This can be an Amplify custom UI component or another custom component.
    - properties
```
Map<K,V> properties
```
      Describes the component's properties. You can't specify tags as a valid property for properties.
    - children
```
List<E> children
```
      A list of the component's ComponentChild instances.
    - variants
```
List<E> variants
```
      A list of the component's variants. A variant is a unique style configuration of a main component.
    - overrides
```
Map<K,V> overrides
```
      Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.
    - bindingProperties
```
Map<K,V> bindingProperties
```
      The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.
    - collectionProperties
```
Map<K,V> collectionProperties
```
      The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.
    - createdAt
```
Date createdAt
```
      The time that the component was created.
    - modifiedAt
```
Date modifiedAt
```
      The time that the component was modified.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the component.
    - events
```
Map<K,V> events
```
      Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the component when it was imported.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValue extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The property type.
    - bindingProperties
```
ComponentBindingPropertiesValueProperties bindingProperties
```
      Describes the properties to customize with data at runtime.
    - defaultValue
```
String defaultValue
```
      The default value of the property.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentBindingPropertiesValueProperties extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      An Amplify DataStore model.
    - field
```
String field
```
      The field to bind the data to.
    - predicates
```
List<E> predicates
```
      A list of predicates for binding a component's properties to data.
    - userAttribute
```
String userAttribute
```
      An authenticated user attribute.
    - bucket
```
String bucket
```
      An Amazon S3 bucket.
    - key
```
String key
```
      The storage key for an Amazon S3 bucket.
    - defaultValue
```
String defaultValue
```
      The default value to assign to the property.
    - slotName
```
String slotName
```
      The name of a component slot.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentChild extends Object implements Serializable
  - Serialized Fields
    - componentType
```
String componentType
```
      The type of the child component.
    - name
```
String name
```
      The name of the child component.
    - properties
```
Map<K,V> properties
```
      Describes the properties of the child component. You can't specify tags as a valid property for properties.
    - children
```
List<E> children
```
      The list of ComponentChild instances for this component.
    - events
```
Map<K,V> events
```
      Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    - sourceId
```
String sourceId
```
      The unique ID of the child component in its original source system, such as Figma.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentConditionProperty extends Object implements Serializable
  - Serialized Fields
    - property
```
String property
```
      The name of the conditional property.
    - field
```
String field
```
      The name of a field. Specify this when the property is a data model.
    - operator
```
String operator
```
      The operator to use to perform the evaluation, such as eq to represent equals.
    - operand
```
String operand
```
      The value of the property to evaluate.
    - then
```
ComponentProperty then
```
      The value to assign to the property if the condition is met.
    - elseValue
```
ComponentProperty elseValue
```
      The value to assign to the property if the condition is not met.
    - operandType
```
String operandType
```
      The type of the property to evaluate.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentDataConfiguration extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      The name of the data model to use to bind data to a component.
    - sort
```
List<E> sort
```
      Describes how to sort the component's properties.
    - predicate
```
Predicate predicate
```
      Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
    - identifiers
```
List<E> identifiers
```
      A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentEvent extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action to perform when a specific event is raised.
    - parameters
```
ActionParameters parameters
```
      Describes information about the action.
    - bindingEvent
```
String bindingEvent
```
      Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentProperty extends Object implements Serializable
  - Serialized Fields
    - value
```
String value
```
      The value to assign to the component property.
    - bindingProperties
```
ComponentPropertyBindingProperties bindingProperties
```
      The information to bind the component property to data at runtime.
    - collectionBindingProperties
```
ComponentPropertyBindingProperties collectionBindingProperties
```
      The information to bind the component property to data at runtime. Use this for collection components.
    - defaultValue
```
String defaultValue
```
      The default value to assign to the component property.
    - model
```
String model
```
      The data model to use to assign a value to the component property.
    - bindings
```
Map<K,V> bindings
```
      The information to bind the component property to form data.
    - event
```
String event
```
      An event that occurs in your app. Use this for workflow data binding.
    - userAttribute
```
String userAttribute
```
      An authenticated user attribute to use to assign a value to the component property.
    - concat
```
List<E> concat
```
      A list of component properties to concatenate to create the value to assign to this component property.
    - condition
```
ComponentConditionProperty condition
```
      The conditional expression to use to assign a value to the component property.
    - configured
```
Boolean configured
```
      Specifies whether the user configured the property in Amplify Studio after importing it.
    - type
```
String type
```
      The component type.
    - importedValue
```
String importedValue
```
      The default value assigned to the property when the component is imported into an app.
    - componentName
```
String componentName
```
      The name of the component that is affected by an event.
    - property
```
String property
```
      The name of the component's property that is affected by an event.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentPropertyBindingProperties extends Object implements Serializable
  - Serialized Fields
    - property
```
String property
```
      The component property to bind to the data field.
    - field
```
String field
```
      The data field to bind the property to.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentSummary extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the component.
    - name
```
String name
```
      The name of the component.
    - componentType
```
String componentType
```
      The component type.
- Class com.amazonaws.services.amplifyuibuilder.model.ComponentVariant extends Object implements Serializable
  - Serialized Fields
    - variantValues
```
Map<K,V> variantValues
```
      The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
    - overrides
```
Map<K,V> overrides
```
      The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentData extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the component
    - sourceId
```
String sourceId
```
      The unique ID of the component in its original source system, such as Figma.
    - componentType
```
String componentType
```
      The component type. This can be an Amplify custom UI component or another custom component.
    - properties
```
Map<K,V> properties
```
      Describes the component's properties.
    - children
```
List<E> children
```
      A list of child components that are instances of the main component.
    - variants
```
List<E> variants
```
      A list of the unique variants of this component.
    - overrides
```
Map<K,V> overrides
```
      Describes the component properties that can be overriden to customize an instance of the component.
    - bindingProperties
```
Map<K,V> bindingProperties
```
      The data binding information for the component's properties.
    - collectionProperties
```
Map<K,V> collectionProperties
```
      The data binding configuration for customizing a component's properties. Use this for a collection component.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the component data.
    - events
```
Map<K,V> events
```
      The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the component when it was imported.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to associate with the component.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - clientToken
```
String clientToken
```
      The unique client token.
    - componentToCreate
```
CreateComponentData componentToCreate
```
      Represents the configuration of the component to create.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Component entity
```
      Describes the configuration of the new component.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormData extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the form.
    - dataType
```
FormDataTypeConfig dataType
```
      The type of data source to use to create the form.
    - formActionType
```
String formActionType
```
      Specifies whether to perform a create or update action on the form.
    - fields
```
Map<K,V> fields
```
      The configuration information for the form's fields.
    - style
```
FormStyle style
```
      The configuration for the form's style.
    - sectionalElements
```
Map<K,V> sectionalElements
```
      The configuration information for the visual helper elements for the form. These elements are not associated with any data.
    - schemaVersion
```
String schemaVersion
```
      The schema version of the form.
    - cta
```
FormCTA cta
```
      The FormCTA object that stores the call to action configuration for the form.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the form data.
    - labelDecorator
```
String labelDecorator
```
      Specifies an icon or decoration to display on the form.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to associate with the form.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - clientToken
```
String clientToken
```
      The unique client token.
    - formToCreate
```
CreateFormData formToCreate
```
      Represents the configuration of the form to create.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateFormResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Form entity
```
      Describes the configuration of the new form.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeData extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the theme.
    - values
```
List<E> values
```
      A list of key-value pairs that deﬁnes the properties of the theme.
    - overrides
```
List<E> overrides
```
      Describes the properties that can be overriden to customize an instance of the theme.
    - tags
```
Map<K,V> tags
```
      One or more key-value pairs to use when tagging the theme data.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the theme.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - clientToken
```
String clientToken
```
      The unique client token.
    - themeToCreate
```
CreateThemeData themeToCreate
```
      Represents the configuration of the theme to create.
- Class com.amazonaws.services.amplifyuibuilder.model.CreateThemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entity
```
Theme entity
```
      Describes the configuration of the new theme.
- Class com.amazonaws.services.amplifyuibuilder.model.DataStoreRenderConfig extends Object implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the component to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the component to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteFormRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the form to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the form to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteFormResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteThemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app associated with the theme to delete.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - id
```
String id
```
      The unique ID of the theme to delete.
- Class com.amazonaws.services.amplifyuibuilder.model.DeleteThemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - provider
```
String provider
```
      The third-party provider for the token. The only valid value is figma.
    - request
```
ExchangeCodeForTokenRequestBody request
```
      Describes the configuration of the request.
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenRequestBody extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The access code to send in the request.
    - redirectUri
```
String redirectUri
```
      The location of the application that will receive the access code.
    - clientId
```
String clientId
```
      The ID of the client to request the token from.
- Class com.amazonaws.services.amplifyuibuilder.model.ExchangeCodeForTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token.
    - expiresIn
```
Integer expiresIn
```
      The date and time when the new access token expires.
    - refreshToken
```
String refreshToken
```
      The token to use to refresh a previously issued access token that might have expired.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportComponentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export components to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportComponentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported components.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportFormsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export forms to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is a part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportFormsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported forms.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportThemesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      The unique ID of the Amplify app to export the themes to.
    - environmentName
```
String environmentName
```
      The name of the backend environment that is part of the Amplify app.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.amplifyuibuilder.model.ExportThemesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      Represents the configuration of the exported themes.
    - nextToken
```
String nextToken
```
      The pagination token that's included if more results are available.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldConfig extends Object implements Serializable
  - Serialized Fields
    - label
```
String label
```
      The label for the field.
    - position
```
FieldPosition position
```
      Specifies the field position.
    - excluded
```
Boolean excluded
```
      Specifies whether to hide a field.
    - inputType
```
FieldInputConfig inputType
```
      Describes the configuration for the default input value to display for a field.
    - validations
```
List<E> validations
```
      The validations to perform on the value in the field.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldInputConfig extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The input type for the field.
    - required
```
Boolean required
```
      Specifies a field that requires input.
    - readOnly
```
Boolean readOnly
```
      Specifies a read only field.
    - placeholder
```
String placeholder
```
      The text to display as a placeholder for the field.
    - defaultValue
```
String defaultValue
```
      The default value for the field.
    - descriptiveText
```
String descriptiveText
```
      The text to display to describe the field.
    - defaultChecked
```
Boolean defaultChecked
```
      Specifies whether a field has a default value.
    - defaultCountryCode
```
String defaultCountryCode
```
      The default country code for a phone number.
    - valueMappings
```
ValueMappings valueMappings
```
      The information to use to customize the input fields with data at runtime.
    - name
```
String name
```
      The name of the field.
    - minValue
```
Float minValue
```
      The minimum value to display for the field.
    - maxValue
```
Float maxValue
```
      The maximum value to display for the field.
    - step
```
Float step
```
      The stepping increment for a numeric value in a field.
    - value
```
String value
```
      The value for the field.
    - isArray
```
Boolean isArray
```
      Specifies whether to render the field as an array. This property is ignored if the dataSourceType for the form is a Data Store.
    - fileUploaderConfig
```
FileUploaderFieldConfig fileUploaderConfig
```
      The configuration for the file uploader field.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldPosition extends Object implements Serializable
  - Serialized Fields
    - fixed
```
String fixed
```
      The field position is fixed and doesn't change in relation to other fields.
    - rightOf
```
String rightOf
```
      The field position is to the right of the field specified by the string.
    - below
```
String below
```
      The field position is below the field specified by the string.
- Class com.amazonaws.services.amplifyuibuilder.model.FieldValidationConfiguration extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The validation to perform on an object type.



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 Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to
 receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with
 amazon-apigateway-.
 








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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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

 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. This parameter is deprecated and should not be used.
 


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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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

 The string identifier of the associated RestApi.
 


name
String name

 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.CreateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The identifier for the authorizer resource.
 


name
String name

 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

 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

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

 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

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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

 The string identifier of the associated RestApi.
 


location
DocumentationPartLocation location

 The location of the targeted API entity of the to-be-created documentation part.
 


properties
String properties

 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

 The string identifier of the associated RestApi.
 


documentationVersion
String documentationVersion

 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

 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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
 domain name. 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 Amazon Web Services-managed certificate that will be used by regional endpoint for this
 domain name. 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.
 


mutualTlsAuthentication
MutualTlsAuthenticationInput mutualTlsAuthentication


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
 








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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
 domain name. 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 Amazon Web Services-managed certificate that will be used for validating the regional domain
 name. 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way
 authentication between the client and the server. Clients must present a trusted certificate to access your API.
 


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
 








Class com.amazonaws.services.apigateway.model.CreateModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The RestApi identifier under which the Model will be created.
 


name
String name

 The name of the model. 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. The
 maximum size of the model is 400 KB.
 


contentType
String contentType

 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

 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

 The string identifier of the associated RestApi.
 


parentId
String parentId

 The parent resource's identifier.
 


pathPart
String pathPart

 The last path segment for this resource.
 








Class com.amazonaws.services.apigateway.model.CreateResourceResult extends 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.
 








Class com.amazonaws.services.apigateway.model.CreateRestApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the RestApi.
 


description
String description

 The description of the RestApi.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
 








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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








Class com.amazonaws.services.apigateway.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


stageName
String stageName

 The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores.
 Maximum length is 128 characters.
 


deploymentId
String deploymentId

 The identifier of the Deployment resource for the Stage resource.
 


description
String description

 The description of the Stage resource.
 


cacheClusterEnabled
Boolean cacheClusterEnabled

 Whether cache clustering is enabled for the stage.
 


cacheClusterSize
String cacheClusterSize

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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. To activate a method-level cache, set
 CachingEnabled to true for a method.
 


cacheClusterSize
String cacheClusterSize

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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

 The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource
 representing a plan customer.
 


keyId
String keyId

 The identifier of a UsagePlanKey resource for a plan customer.
 


keyType
String keyType

 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

 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

 A map containing method level throttling information for API stage in a usage plan.
 


quota
QuotaSettings quota

 The target maximum number of permitted requests per a given unit time interval.
 


productCode
String productCode

 The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
 Amazon Web Services 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

 The name used to label and identify the VPC link.
 


description
String description

 The description of the VPC link.
 


targetArns
List<E> targetArns

 The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned
 by the same Amazon Web Services 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 ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned
 by the same Amazon Web Services 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

 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

 The string identifier of the associated RestApi.
 


authorizerId
String authorizerId

 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

 The domain name of the BasePathMapping resource to delete.
 


basePath
String basePath

 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

 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

 The string identifier of the associated RestApi.
 


deploymentId
String deploymentId

 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

 The string identifier of the associated RestApi.
 


documentationPartId
String documentationPartId

 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

 The string identifier of the associated RestApi.
 


documentationVersion
String documentationVersion

 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

 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

 The string identifier of the associated RestApi.
 


responseType
String responseType

 The response type of the associated GatewayResponse.
 








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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a delete integration request's resource identifier.
 


httpMethod
String httpMethod

 Specifies a delete integration request's HTTP method.
 








Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a delete integration response request's resource identifier.
 


httpMethod
String httpMethod

 Specifies a delete integration response request's HTTP method.
 


statusCode
String statusCode

 Specifies a delete integration response request's status code.
 








Class com.amazonaws.services.apigateway.model.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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the Method resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 








Class com.amazonaws.services.apigateway.model.DeleteMethodResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the MethodResponse resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 


statusCode
String statusCode

 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

 The string identifier of the associated RestApi.
 


modelName
String modelName

 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

 The string identifier of the associated RestApi.
 


requestValidatorId
String requestValidatorId

 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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 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

 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

 The string identifier of the associated RestApi.
 


stageName
String stageName

 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

 The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource
 representing a plan customer.
 


keyId
String keyId

 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

 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

 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

 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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
 domain name. 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 Amazon Web Services-managed certificate that will be used for validating the regional domain
 name. 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way
 authentication between the client and the server. Clients must present a trusted certificate to access your API.
 


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
 








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

 The string identifier of the associated RestApi.
 


stageName
String stageName

 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.
 


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

 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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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 Amazon Web Services 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

 The string identifier of the associated RestApi.
 


authorizerId
String authorizerId

 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

 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

 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

 The domain name of the BasePathMapping resource to be described.
 


basePath
String basePath

 The base path name that callers of the API must provide as part of the URL after the domain name. This value must
 be unique for all of the mappings across a single API. 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

 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

 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

 The string identifier of the associated RestApi.
 


deploymentId
String deploymentId

 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

 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

 The string identifier of the associated RestApi.
 


documentationPartId
String documentationPartId

 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

 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

 The string identifier of the associated RestApi.
 


documentationVersion
String documentationVersion

 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

 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

 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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
 domain name. 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 Amazon Web Services-managed certificate that will be used for validating the regional domain
 name. 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way
 authentication between the client and the server. Clients must present a trusted certificate to access your API.
 


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
 








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

 The string identifier of the associated RestApi.
 


stageName
String stageName

 The name of the Stage that will be exported.
 


exportType
String exportType

 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

 The string identifier of the associated RestApi.
 


responseType
String responseType

 The response type of the associated GatewayResponse.
 








Class com.amazonaws.services.apigateway.model.GetGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responseType
String responseType

 The response type of the associated GatewayResponse.
 


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

 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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a get integration request's resource identifier
 


httpMethod
String httpMethod

 Specifies a get integration request's HTTP method.
 








Class com.amazonaws.services.apigateway.model.GetIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a get integration response request's resource identifier.
 


httpMethod
String httpMethod

 Specifies a get integration response request's HTTP method.
 


statusCode
String statusCode

 Specifies a get integration response request's status code.
 








Class com.amazonaws.services.apigateway.model.GetIntegrationResponseResult extends 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 Lambda
 function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services 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:
 
 
 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:
 
 
 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. For the Type property, if you specify MOCK, this
 property is optional. For Lambda integrations, you must set the integration method to POST. For all
 other types, you must specify this property.
 


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 standard integrations. If connectionType is
 VPC_LINK specify the Network Load Balancer DNS name. 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 Amazon Web Services service
 (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast
 host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services service
 path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including
 the region of the integrated Amazon Web Services 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 Amazon Web Services
 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:
 
 
 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

 Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
 cacheNamespace. You can specify the same cacheNamespace across resources to return the
 same cached data for requests to different resources.
 


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.
 


tlsConfig
TlsConfig tlsConfig

 Specifies the TLS configuration for an integration.
 








Class com.amazonaws.services.apigateway.model.GetMethodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the Method resource.
 


httpMethod
String httpMethod

 Specifies the method request's HTTP method type.
 








Class com.amazonaws.services.apigateway.model.GetMethodResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the MethodResponse resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 


statusCode
String statusCode

 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.
 


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.
 


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

 The RestApi identifier under which the Model exists.
 


modelName
String modelName

 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

 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

 The string identifier of the associated RestApi.
 


modelName
String modelName

 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

 The string identifier of the associated RestApi.
 


requestValidatorId
String requestValidatorId

 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

 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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 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.
 








Class com.amazonaws.services.apigateway.model.GetResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 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

 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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








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

 The string identifier of the associated RestApi.
 


stageName
String stageName

 The name of the Stage that the SDK will use.
 


sdkType
String sdkType

 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

 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

 The string identifier of the associated RestApi.
 


stageName
String stageName

 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. To activate a method-level cache, set
 CachingEnabled to true for a method.
 


cacheClusterSize
String cacheClusterSize

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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

 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

 The ARN of a resource that can be tagged.
 


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

 The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource
 representing a plan customer.
 


keyId
String keyId

 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

 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

 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

 A map containing method level throttling information for API stage in a usage plan.
 


quota
QuotaSettings quota

 The target maximum number of permitted requests per a given unit time interval.
 


productCode
String productCode

 The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
 Amazon Web Services 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

 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

 The starting date (e.g., 2016-01-01) of the usage data.
 


endDate
String endDate

 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

 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 ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned
 by the same Amazon Web Services 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

 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

 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.
 


body
ByteBuffer body

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








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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








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:
 
 
 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. For the Type property, if you specify MOCK, this
 property is optional. For Lambda integrations, you must set the integration method to POST. For all
 other types, you must specify this property.
 


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 standard integrations. If connectionType is
 VPC_LINK specify the Network Load Balancer DNS name. 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 Amazon Web Services service
 (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast
 host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services service
 path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including
 the region of the integrated Amazon Web Services 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 Amazon Web Services
 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:
 
 
 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

 Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
 cacheNamespace. You can specify the same cacheNamespace across resources to return the
 same cached data for requests to different resources.
 


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.
 


tlsConfig
TlsConfig tlsConfig

 Specifies the TLS configuration for an integration.
 








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 Lambda
 function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services 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:
 
 
 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.
 


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.
 


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.
 


loggingLevel
String loggingLevel

 Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
 Valid values are OFF, ERROR, and INFO. Choose ERROR to write
 only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events
 as well as extra informational events.
 


dataTraceEnabled
Boolean dataTraceEnabled

 Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon
 CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend
 that you don't enable this option for production APIs.
 


throttlingBurstLimit
Integer throttlingBurstLimit

 Specifies the throttling burst limit.
 


throttlingRateLimit
Double throttlingRateLimit

 Specifies the throttling rate limit.
 


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.
 


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.
 


cacheDataEncrypted
Boolean cacheDataEncrypted

 Specifies whether the cached responses are encrypted.
 


requireAuthorizationForCacheControl
Boolean requireAuthorizationForCacheControl

 Specifies whether authorization is required for a cache invalidation request.
 


unauthorizedCacheControlHeaderStrategy
String unauthorizedCacheControlHeaderStrategy

 Specifies how to handle unauthorized requests for cache invalidation.
 








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.MutualTlsAuthentication extends Object implements Serializable


Serialized Fields


truststoreUri
String truststoreUri

 An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
 s3://bucket-name/key-name. The truststore can contain certificates from public or private
 certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain
 name to use the new version. To update the truststore, you must have permissions to access the S3 object.
 


truststoreVersion
String truststoreVersion

 The version of the S3 object that contains your truststore. To specify a version, you must have versioning
 enabled for the S3 bucket.
 


truststoreWarnings
List<E> truststoreWarnings

 A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce
 warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve
 warnings, upload a new truststore to S3, and then update you domain name to use the new version.
 








Class com.amazonaws.services.apigateway.model.MutualTlsAuthenticationInput extends Object implements Serializable


Serialized Fields


truststoreUri
String truststoreUri

 An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
 s3://bucket-name/key-name. The truststore can contain certificates from public or private
 certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain
 name to use the new version. To update the truststore, you must have permissions to access the S3 object.
 


truststoreVersion
String truststoreVersion

 The version of the S3 object that contains your truststore. To specify a version, you must have versioning
 enabled for the S3 bucket
 








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": ...}'.
 


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

 The string identifier of the associated RestApi.
 


responseType
String responseType

 The response type of the associated GatewayResponse
 


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.
 


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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a put integration request's resource ID.
 


httpMethod
String httpMethod

 Specifies the HTTP method for the integration.
 


type
String type

 Specifies a put integration input's type.
 


integrationHttpMethod
String integrationHttpMethod

 The HTTP method for the integration.
 


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 Amazon Web Services service
 (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast
 host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services service
 path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including
 the region of the integrated Amazon Web Services 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. Specify this value only if you specify VPC_LINK as
 the connection type.
 


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.
 


cacheNamespace
String cacheNamespace

 Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
 cacheNamespace. You can specify the same cacheNamespace across resources to return the
 same cached data for requests to different resources.
 


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.
 


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


tlsConfig
TlsConfig tlsConfig








Class com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a put integration response request's resource identifier.
 


httpMethod
String httpMethod

 Specifies a put integration response request's HTTP method.
 


statusCode
String statusCode

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


selectionPattern
String selectionPattern

 Specifies the selection pattern of a put integration response.
 


responseParameters
Map<K,V> responseParameters

 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:
 
 
 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 Lambda
 function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services 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:
 
 
 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:
 
 
 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. For the Type property, if you specify MOCK, this
 property is optional. For Lambda integrations, you must set the integration method to POST. For all
 other types, you must specify this property.
 


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 standard integrations. If connectionType is
 VPC_LINK specify the Network Load Balancer DNS name. 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 Amazon Web Services service
 (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast
 host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services service
 path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including
 the region of the integrated Amazon Web Services 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 Amazon Web Services
 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:
 
 
 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

 Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
 cacheNamespace. You can specify the same cacheNamespace across resources to return the
 same cached data for requests to different resources.
 


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.
 


tlsConfig
TlsConfig tlsConfig

 Specifies the TLS configuration for an integration.
 








Class com.amazonaws.services.apigateway.model.PutMethodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the new Method resource.
 


httpMethod
String httpMethod

 Specifies the method request's HTTP method type.
 


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

 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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the Method resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 


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


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.
 


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

 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

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








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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








Class com.amazonaws.services.apigateway.model.QuotaSettings extends Object implements Serializable


Serialized Fields


limit
Integer limit

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








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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








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. To activate a method-level cache, set
 CachingEnabled to true for a method.
 


cacheClusterSize
String cacheClusterSize

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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

 The ARN of a resource that can be tagged.
 


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.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


authorizerId
String authorizerId

 Specifies a test invoke authorizer request's Authorizer ID.
 


headers
Map<K,V> headers

 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

 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

 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.
 


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

 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, in ms, 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

 The authorization response.
 


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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies a test invoke method request's resource ID.
 


httpMethod
String httpMethod

 Specifies a test invoke method request's HTTP method.
 


pathWithQueryString
String pathWithQueryString

 The URI path, including query string, of the simulated invocation request. Use this to specify path parameters
 and query string parameters.
 


body
String body

 The simulated request body of an incoming invocation request.
 


headers
Map<K,V> headers

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


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, in ms, of the test invoke request.
 








Class com.amazonaws.services.apigateway.model.ThrottleSettings extends Object implements Serializable


Serialized Fields


burstLimit
Integer burstLimit

 The API target request burst rate limit. This allows more requests through for a period of time than the target
 rate limit.
 


rateLimit
Double rateLimit

 The API target request rate limit.
 








Class com.amazonaws.services.apigateway.model.TlsConfig extends Object implements Serializable


Serialized Fields


insecureSkipVerification
Boolean insecureSkipVerification

 Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is
 issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that
 are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway
 still performs basic certificate validation, which includes checking the certificate's expiration date, hostname,
 and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY
 integrations.
 
 
 
 Enabling insecureSkipVerification isn't recommended, especially for integrations with public HTTPS
 endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle
 attacks.
 
 








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

 The ARN of a resource that can be tagged.
 


tagKeys
List<E> tagKeys

 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

 For more information about supported patch operations, see Patch Operations.
 








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

 The identifier of the ApiKey resource to be updated.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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

 The string identifier of the associated RestApi.
 


authorizerId
String authorizerId

 The identifier of the Authorizer resource.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 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

 The domain name of the BasePathMapping resource to change.
 


basePath
String basePath

 The base path of the BasePathMapping resource to change.
 
 
 To specify an empty base path, set this parameter to '(none)'.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 The identifier of the ClientCertificate resource to be updated.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 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

 For more information about supported patch operations, see Patch Operations.
 








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

 The string identifier of the associated RestApi.
 


documentationPartId
String documentationPartId

 The identifier of the to-be-updated documentation part.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 The string identifier of the associated RestApi.
 


documentationVersion
String documentationVersion

 The version identifier of the to-be-updated documentation version.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 The name of the DomainName resource to be changed.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this
 domain name. 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 Amazon Web Services-managed certificate that will be used for validating the regional domain
 name. 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way
 authentication between the client and the server. Clients must present a trusted certificate to access your API.
 


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
 








Class com.amazonaws.services.apigateway.model.UpdateGatewayResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


responseType
String responseType

 The response type of the associated GatewayResponse.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








Class com.amazonaws.services.apigateway.model.UpdateGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responseType
String responseType

 The response type of the associated GatewayResponse.
 


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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Represents an update integration request's resource identifier.
 


httpMethod
String httpMethod

 Represents an update integration request's HTTP method.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 Specifies an update integration response request's resource identifier.
 


httpMethod
String httpMethod

 Specifies an update integration response request's HTTP method.
 


statusCode
String statusCode

 Specifies an update integration response request's status code.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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 Lambda
 function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services 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:
 
 
 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:
 
 
 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. For the Type property, if you specify MOCK, this
 property is optional. For Lambda integrations, you must set the integration method to POST. For all
 other types, you must specify this property.
 


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 standard integrations. If connectionType is
 VPC_LINK specify the Network Load Balancer DNS name. 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 Amazon Web Services service
 (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast
 host-name lookup. action can be used for an Amazon Web Services 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 Amazon Web Services service
 path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including
 the region of the integrated Amazon Web Services 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 Amazon Web Services
 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:
 
 
 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

 Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
 cacheNamespace. You can specify the same cacheNamespace across resources to return the
 same cached data for requests to different resources.
 


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.
 


tlsConfig
TlsConfig tlsConfig

 Specifies the TLS configuration for an integration.
 








Class com.amazonaws.services.apigateway.model.UpdateMethodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the Method resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








Class com.amazonaws.services.apigateway.model.UpdateMethodResponseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The Resource identifier for the MethodResponse resource.
 


httpMethod
String httpMethod

 The HTTP verb of the Method resource.
 


statusCode
String statusCode

 The status code for the MethodResponse resource.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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.
 


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.
 


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

 The string identifier of the associated RestApi.
 


modelName
String modelName

 The name of the model to update.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 The string identifier of the associated RestApi.
 


requestValidatorId
String requestValidatorId

 The identifier of RequestValidator to be updated.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 The string identifier of the associated RestApi.
 


resourceId
String resourceId

 The identifier of the Resource resource.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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.
 








Class com.amazonaws.services.apigateway.model.UpdateRestApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
 clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
 endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
 


rootResourceId
String rootResourceId

 The API's root resource ID.
 








Class com.amazonaws.services.apigateway.model.UpdateStageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


restApiId
String restApiId

 The string identifier of the associated RestApi.
 


stageName
String stageName

 The name of the Stage resource to change information about.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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. To activate a method-level cache, set
 CachingEnabled to true for a method.
 


cacheClusterSize
String cacheClusterSize

 The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching
 to enhance responsiveness.
 


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

 The Id of the to-be-updated usage plan.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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

 A map containing method level throttling information for API stage in a usage plan.
 


quota
QuotaSettings quota

 The target maximum number of permitted requests per a given unit time interval.
 


productCode
String productCode

 The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
 Amazon Web Services 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

 The Id of the usage plan associated with the usage data.
 


keyId
String keyId

 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

 For more information about supported patch operations, see Patch Operations.
 








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

 The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
 


patchOperations
List<E> patchOperations

 For more information about supported patch operations, see Patch Operations.
 








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 ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned
 by the same Amazon Web Services 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

 A map containing method level throttling information for API stage in a usage plan.
 


quota
QuotaSettings quota

 The target maximum number of permitted requests per a given unit time interval.
 


productCode
String productCode

 The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
 Amazon Web Services 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 ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned
 by the same Amazon Web Services 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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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, don't specify this parameter. Supported only for REQUEST authorizers.
 


authorizerId
String authorizerId

 The authorizer identifier.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer
 can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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, don't specify this parameter. Supported only for REQUEST authorizers.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must
 return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.
 Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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, don't specify this parameter. Supported only for REQUEST authorizers.
 


authorizerId
String authorizerId

 The authorizer identifier.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer
 can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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.
 


mutualTlsAuthentication
MutualTlsAuthenticationInput mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 


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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 


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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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. For HTTP API private integrations, use an
 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern
 <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove.
 For values, you can provide static values, or map request data, stage variables, or context variables that are
 evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


templateSelectionExpression
String templateSelectionExpression

 The template selection expression for the integration.
 


timeoutInMillis
Integer timeoutInMillis

 Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfigInput tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the
 pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or
 remove. For values, you can provide static values, or map request data, stage variables, or context variables
 that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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 for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfig tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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


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


tags
Map<K,V> tags

 The collection of tags. Each tag element is associated with a given resource.
 








Class com.amazonaws.services.apigatewayv2.model.CreateVpcLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the VPC link.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs for the VPC link.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs to include in the VPC link.
 


tags
Map<K,V> tags

 A list of tags.
 








Class com.amazonaws.services.apigatewayv2.model.CreateVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createdDate
Date createdDate

 The timestamp when the VPC link was created.
 


name
String name

 The name of the VPC link.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs for the VPC link.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs to include in the VPC link.
 


tags
Map<K,V> tags

 Tags for the VPC link.
 


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 


vpcLinkStatus
String vpcLinkStatus

 The status of the VPC link.
 


vpcLinkStatusMessage
String vpcLinkStatusMessage

 A message summarizing the cause of the status of the VPC link.
 


vpcLinkVersion
String vpcLinkVersion

 The version of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.DeleteAccessLogSettingsRequest 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.DeleteAccessLogSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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.DeleteRouteRequestParameterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


apiId
String apiId

 The API identifier.
 


requestParameterKey
String requestParameterKey

 The route request parameter key.
 


routeId
String routeId

 The route ID.
 








Class com.amazonaws.services.apigatewayv2.model.DeleteRouteRequestParameterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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.DeleteVpcLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.DeleteVpcLinkResult 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 


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, UPDATING, PENDING_CERTIFICATE_REIMPORT,
 and PENDING_OWNERSHIP_VERIFICATION. 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.
 


ownershipVerificationCertificateArn
String ownershipVerificationCertificateArn

 The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when
 configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn
 








Class com.amazonaws.services.apigatewayv2.model.ExportApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


apiId
String apiId

 The API identifier.
 


exportVersion
String exportVersion

 The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the
 only supported version is 1.0.
 


includeExtensions
Boolean includeExtensions

 Specifies whether to include API
 Gateway extensions in the exported API definition. API Gateway extensions are included by default.
 


outputType
String outputType

 The output type of the exported definition file. Valid values are JSON and YAML.
 


specification
String specification

 The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
 


stageName
String stageName

 The name of the API stage to export. If you don't specify this property, a representation of the latest API
 configuration is exported.
 








Class com.amazonaws.services.apigatewayv2.model.ExportApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


body
ByteBuffer body








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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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, don't specify this parameter. Supported only for REQUEST authorizers.
 


authorizerId
String authorizerId

 The authorizer identifier.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer
 can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 


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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the
 pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or
 remove. For values, you can provide static values, or map request data, stage variables, or context variables
 that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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 for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfig tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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


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.GetVpcLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.GetVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createdDate
Date createdDate

 The timestamp when the VPC link was created.
 


name
String name

 The name of the VPC link.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs for the VPC link.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs to include in the VPC link.
 


tags
Map<K,V> tags

 Tags for the VPC link.
 


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 


vpcLinkStatus
String vpcLinkStatus

 The status of the VPC link.
 


vpcLinkStatusMessage
String vpcLinkStatusMessage

 A message summarizing the cause of the status of the VPC link.
 


vpcLinkVersion
String vpcLinkVersion

 The version of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.GetVpcLinksRequest 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.GetVpcLinksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 A collection of VPC links.
 


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.ImportApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


basepath
String basepath

 Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split.
 The default value is ignore. To learn more, see Set the
 OpenAPI basePath Property. 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 when a warning is encountered. By default, API creation continues
 if a warning is encountered.
 








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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the
 pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or
 remove. For values, you can provide static values, or map request data, stage variables, or context variables
 that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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 for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfig tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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.MutualTlsAuthentication extends Object implements Serializable


Serialized Fields


truststoreUri
String truststoreUri

 An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example,
 s3://bucket-name/key-name. The truststore can contain
 certificates from public or private certificate authorities. To update the truststore, upload a new version to
 S3, and then update your custom domain name to use the new version. To update the truststore, you must have
 permissions to access the S3 object.
 


truststoreVersion
String truststoreVersion

 The version of the S3 object that contains your truststore. To specify a version, you must have versioning
 enabled for the S3 bucket.
 


truststoreWarnings
List<E> truststoreWarnings

 A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce
 warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve
 warnings, upload a new truststore to S3, and then update you domain name to use the new version.
 








Class com.amazonaws.services.apigatewayv2.model.MutualTlsAuthenticationInput extends Object implements Serializable


Serialized Fields


truststoreUri
String truststoreUri

 An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example,
 s3://bucket-name/key-name. The truststore can contain
 certificates from public or private certificate authorities. To update the truststore, upload a new version to
 S3, and then update your custom domain name to use the new version. To update the truststore, you must have
 permissions to access the S3 object.
 


truststoreVersion
String truststoreVersion

 The version of the S3 object that contains your truststore. To specify a version, you must have versioning
 enabled for the S3 bucket.
 








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

 Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split.
 The default value is ignore. To learn more, see Set the
 OpenAPI basePath Property. 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 when a warning is encountered. By default, API creation continues
 if a warning is encountered.
 








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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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.ResetAuthorizersCacheRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


apiId
String apiId

 The API identifier.
 


stageName
String stageName

 The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default.
 Maximum length is 128 characters.
 








Class com.amazonaws.services.apigatewayv2.model.ResetAuthorizersCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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.
 


throttlingRateLimit
Double throttlingRateLimit

 Specifies the throttling rate limit.
 








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


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.TlsConfig extends Object implements Serializable


Serialized Fields


serverNameToVerify
String serverNameToVerify

 If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The
 server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
 








Class com.amazonaws.services.apigatewayv2.model.TlsConfigInput extends Object implements Serializable


Serialized Fields


serverNameToVerify
String serverNameToVerify

 If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The
 server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
 








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, don't specify this parameter.
 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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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.
 


apiGatewayManaged
Boolean apiGatewayManaged

 Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
 Gateway. A managed API can be deleted only through the tooling or service that created it.
 


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.
 


disableExecuteApiEndpoint
Boolean disableExecuteApiEndpoint

 Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can
 invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that
 clients use a custom domain name to invoke your API, disable the default endpoint.
 


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, don't specify this parameter.
 


authorizerId
String authorizerId

 The authorizer identifier.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must
 return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy.
 Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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, don't specify this parameter. Supported only for REQUEST authorizers.
 


authorizerId
String authorizerId

 The authorizer identifier.
 


authorizerPayloadFormatVersion
String authorizerPayloadFormatVersion

 Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda
 authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is
 disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour.
 Supported only for HTTP API Lambda authorizers.
 


authorizerType
String authorizerType

 The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use
 JSON Web Tokens (supported only for HTTP APIs).
 


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.
 


enableSimpleResponses
Boolean enableSimpleResponses

 Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer
 can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs
 


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. 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 for WebSocket APIs. For HTTP
 APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name.
 These parameters are 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 HTTP APIs, identity sources are also used as the cache key when caching
 is enabled. To learn more, see Working with
 AWS Lambda authorizers for HTTP APIs.
 
 
 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.
 


mutualTlsAuthentication
MutualTlsAuthenticationInput mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 








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.
 


mutualTlsAuthentication
MutualTlsAuthentication mutualTlsAuthentication

 The mutual TLS authentication configuration for a custom domain name.
 


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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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. For HTTP API private integrations, use an
 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern
 <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove.
 For values, you can provide static values, or map request data, stage variables, or context variables that are
 evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


templateSelectionExpression
String templateSelectionExpression

 The template selection expression for the integration.
 


timeoutInMillis
Integer timeoutInMillis

 Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfigInput tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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 ID of the VPC link for a private integration. Supported only for HTTP APIs.
 


connectionType
String connectionType

 The type of the network connection to the integration endpoint. Specify INTERNET for connections through the
 public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The
 default value is 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.
 


integrationSubtype
String integrationSubtype

 Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more,
 see Integration subtype reference.
 


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 a Lambda function or other AWS service action. This
 integration is also referred to as a 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 the 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 integration, specify the URI of a Lambda function.
 
 
 For an HTTP integration, specify a fully-qualified URL.
 
 
 For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load
 Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses
 DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn
 more, see DiscoverInstances. For
 private integrations, all resources must be owned by the same AWS account.
 


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.
 


requestParameters
Map<K,V> requestParameters

 For WebSocket APIs, 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.
 
 
 For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying
 parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage
 variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
 
 
 For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map
 specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the
 pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or
 remove. For values, you can provide static values, or map request data, stage variables, or context variables
 that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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.
 


responseParameters
Map<K,V> responseParameters

 Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend
 integration before returning the response to clients. Specify a key-value map from a selection key to response
 parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters
 are a key-value map. The key must match pattern <action>:<header>.<location> or
 overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to
 response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming
 API requests and responses.
 


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 for WebSocket APIs and between 50 and 30,000 milliseconds for
 HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
 


tlsConfig
TlsConfig tlsConfig

 The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic
 uses the HTTPS protocol. Supported only 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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda
 authorizer.
 


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 contain only alphanumeric characters, hyphens, and underscores, or be $default.
 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-._~:/?#&=,]+.
 








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


tags
Map<K,V> tags

 The collection of tags. Each tag element is associated with a given resource.
 








Class com.amazonaws.services.apigatewayv2.model.UpdateVpcLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the VPC link.
 


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.UpdateVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createdDate
Date createdDate

 The timestamp when the VPC link was created.
 


name
String name

 The name of the VPC link.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs for the VPC link.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs to include in the VPC link.
 


tags
Map<K,V> tags

 Tags for the VPC link.
 


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 


vpcLinkStatus
String vpcLinkStatus

 The status of the VPC link.
 


vpcLinkStatusMessage
String vpcLinkStatusMessage

 A message summarizing the cause of the status of the VPC link.
 


vpcLinkVersion
String vpcLinkVersion

 The version of the VPC link.
 








Class com.amazonaws.services.apigatewayv2.model.VpcLink extends Object implements Serializable


Serialized Fields


createdDate
Date createdDate

 The timestamp when the VPC link was created.
 


name
String name

 The name of the VPC link.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs for the VPC link.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs to include in the VPC link.
 


tags
Map<K,V> tags

 Tags for the VPC link.
 


vpcLinkId
String vpcLinkId

 The ID of the VPC link.
 


vpcLinkStatus
String vpcLinkStatus

 The status of the VPC link.
 


vpcLinkStatusMessage
String vpcLinkStatusMessage

 A message summarizing the cause of the status of the VPC link.
 


vpcLinkVersion
String vpcLinkVersion

 The version of the VPC link.
 








Package com.amazonaws.services.appconfig.model




Class com.amazonaws.services.appconfig.model.Action extends Object implements Serializable


Serialized Fields


name
String name

 The action name.
 


description
String description

 Information about the action.
 


uri
String uri

 The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource
 Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple
 Notification Service topic, or the Amazon EventBridge default event bus.
 


roleArn
String roleArn

 An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
 








Class com.amazonaws.services.appconfig.model.ActionInvocation extends Object implements Serializable


Serialized Fields


extensionIdentifier
String extensionIdentifier

 The name, the ID, or the Amazon Resource Name (ARN) of the extension.
 


actionName
String actionName

 The name of the action.
 


uri
String uri

 The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource
 Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple
 Notification Service topic, or the Amazon EventBridge default event bus.
 


roleArn
String roleArn

 An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
 


errorMessage
String errorMessage

 The error message when an extension invocation fails.
 


errorCode
String errorCode

 The error code when an extension invocation fails.
 


invocationId
String invocationId

 A system-generated ID for this invocation.
 








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.AppliedExtension extends Object implements Serializable


Serialized Fields


extensionId
String extensionId

 The system-generated ID of the extension.
 


extensionAssociationId
String extensionAssociationId

 The system-generated ID for the association.
 


versionNumber
Integer versionNumber

 The extension version number.
 


parameters
Map<K,V> parameters

 One or more parameters for the actions called by the extension.
 








Class com.amazonaws.services.appconfig.model.BadRequestDetails extends Object implements Serializable


Serialized Fields


invalidConfiguration
List<E> invalidConfiguration

 Detailed information about the bad request exception error when creating a hosted configuration version.
 








Class com.amazonaws.services.appconfig.model.BadRequestException extends AmazonAppConfigException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason


details
BadRequestDetails details








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.
 


type
String type

 The type of configurations contained in the profile. AppConfig supports feature flags and
 freeform configurations. We recommend you create feature flag configurations to enable or disable
 new features and freeform configurations to distribute configurations to an application. When calling this API,
 enter one of the following values for Type:
 
 
 AWS.AppConfig.FeatureFlags
 
 
 AWS.Freeform
 








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 the following:
 
 
 
 
 For the AppConfig hosted configuration store and for feature flags, specify hosted.
 
 
 
 
 For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the
 format ssm-parameter://<parameter name> or the ARN.
 
 
 
 
 For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format:
 codepipeline://<pipeline name>.
 
 
 
 
 For an Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret
 name>.
 
 
 
 
 For an Amazon S3 object, specify the URI in the following format:
 s3://<bucket>/<objectKey> . Here is an example:
 s3://my-bucket/my-app/us-east-1/my-config.json
 
 
 
 
 For an SSM document, specify either the document name in the format
 ssm-document://<document name> or the Amazon Resource Name (ARN).
 
 
 


retrievalRoleArn
String retrievalRoleArn

 The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
 
 
 
 A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is
 required for all other sources that store your configuration.
 
 


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.
 


type
String type

 The type of configurations contained in the profile. AppConfig supports feature flags and
 freeform configurations. We recommend you create feature flag configurations to enable or disable
 new features and freeform configurations to distribute configurations to an application. When calling this API,
 enter one of the following values for Type:
 
 
 AWS.AppConfig.FeatureFlags
 
 
 AWS.Freeform
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig
 hosted configuration store. This attribute is only used for hosted configuration types. The
 identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data
 managed in other configuration stores, see the documentation for how to specify an KMS key for that particular
 service.
 








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.
 


type
String type

 The type of configurations contained in the profile. AppConfig supports feature flags and
 freeform configurations. We recommend you create feature flag configurations to enable or disable
 new features and freeform configurations to distribute configurations to an application. When calling this API,
 enter one of the following values for Type:
 
 
 AWS.AppConfig.FeatureFlags
 
 
 AWS.Freeform
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the
 AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To
 encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that
 particular service.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 








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

 Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been
 deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered
 during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back
 based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.
 


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. AppConfig supports the following growth types:
 
 
 Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the
 value specified for Step percentage. For example, a linear deployment that uses a
 Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments
 are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the
 targets have successfully received the configuration.
 
 
 Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
 G*(2^N). In this formula, G is the growth factor specified by the user and
 N is the number of steps until the configuration is deployed to all targets. For example, if you
 specify a growth factor of 2, then the system rolls out the configuration as follows:
 
 
 2*(2^0)
 
 
 2*(2^1)
 
 
 2*(2^2)
 
 
 Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the
 targets, and continues until the configuration has been deployed to all targets.
 


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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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.CreateExtensionAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionIdentifier
String extensionIdentifier

 The name, the ID, or the Amazon Resource Name (ARN) of the extension.
 


extensionVersionNumber
Integer extensionVersionNumber

 The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.
 


resourceIdentifier
String resourceIdentifier

 The ARN of an application, configuration profile, or environment.
 


parameters
Map<K,V> parameters

 The parameter names and values defined in the extensions. Extension parameters marked Required must
 be entered for this field.
 


tags
Map<K,V> tags

 Adds one or more tags for the specified extension association. Tags are metadata that help you categorize
 resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an
 optional value, both of which you define.
 








Class com.amazonaws.services.appconfig.model.CreateExtensionAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID for the association.
 


extensionArn
String extensionArn

 The ARN of the extension defined in the association.
 


resourceArn
String resourceArn

 The ARNs of applications, configuration profiles, or environments defined in the association.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


parameters
Map<K,V> parameters

 The parameter names and values defined in the association.
 


extensionVersionNumber
Integer extensionVersionNumber

 The version number for the extension defined in the association.
 








Class com.amazonaws.services.appconfig.model.CreateExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A name for the extension. Each extension name in your account must be unique. Extension versions use the same
 name.
 


description
String description

 Information about the extension.
 


actions
Map<K,V> actions

 The actions defined in the extension.
 


parameters
Map<K,V> parameters

 The parameters accepted by the extension. You specify parameter values when you associate the extension to an
 AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
 these parameters are included in the Lambda request object.
 


tags
Map<K,V> tags

 Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in
 different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,
 both of which you define.
 


latestVersionNumber
Integer latestVersionNumber

 You can omit this field when you create an extension. When you create a new version, specify the most recent
 current version number. For example, you create version 3, enter 2 for this field.
 








Class com.amazonaws.services.appconfig.model.CreateExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID of the extension.
 


name
String name

 The extension name.
 


versionNumber
Integer versionNumber

 The extension version number.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


description
String description

 Information about the extension.
 


actions
Map<K,V> actions

 The actions defined in the extension.
 


parameters
Map<K,V> parameters

 The parameters accepted by the extension. You specify parameter values when you associate the extension to an
 AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
 these parameters are included in the Lambda request object.
 








Class com.amazonaws.services.appconfig.model.CreateHostedConfigurationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


description
String description

 A description of the configuration.
 


content
ByteBuffer content

 The content of the configuration or the configuration data.
 


contentType
String contentType

 A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
 


latestVersionNumber
Integer latestVersionNumber

 An optional locking token used to prevent race conditions from overwriting configuration updates when creating a
 new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid
 succession, specify the version number of the latest hosted configuration version.
 


versionLabel
String versionLabel

 An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least
 one non-numeric character. For example, "v2.2.0".
 








Class com.amazonaws.services.appconfig.model.CreateHostedConfigurationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


versionNumber
Integer versionNumber

 The configuration version.
 


description
String description

 A description of the configuration.
 


content
ByteBuffer content

 The content of the configuration or the configuration data.
 


contentType
String contentType

 A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the
 configuration data in the AppConfig hosted configuration store.
 








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 that you want to delete.
 


environmentId
String environmentId

 The ID of the environment that you want to delete.
 








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




Class com.amazonaws.services.appconfig.model.DeleteExtensionAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionAssociationId
String extensionAssociationId

 The ID of the extension association to delete.
 








Class com.amazonaws.services.appconfig.model.DeleteExtensionAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appconfig.model.DeleteExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionIdentifier
String extensionIdentifier

 The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
 


versionNumber
Integer versionNumber

 A specific version of an extension to delete. If omitted, the highest version is deleted.
 








Class com.amazonaws.services.appconfig.model.DeleteExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appconfig.model.DeleteHostedConfigurationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


versionNumber
Integer versionNumber

 The versions number to delete.
 








Class com.amazonaws.services.appconfig.model.DeleteHostedConfigurationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appconfig.model.DeploymentEvent extends Object implements Serializable


Serialized Fields


eventType
String eventType

 The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a
 percentage update; the start or stop of a bake period; and the start or completion of a rollback.
 


triggeredBy
String triggeredBy

 The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon
 CloudWatch alarm, or an internal error.
 


description
String description

 A description of the deployment event. Descriptions include, but are not limited to, the following:
 
 
 
 
 The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.
 
 
 
 
 The percentage of hosts that received the deployment.
 
 
 
 
 A recommendation to attempt a new deployment (in the case of an internal error).
 
 
 


actionInvocations
List<E> actionInvocations

 The list of extensions that were invoked as part of the deployment.
 


occurredAt
Date occurredAt

 The date and time the event occurred.
 








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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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 that AppConfig monitors for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 








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.ExtensionAssociationSummary extends Object implements Serializable


Serialized Fields


id
String id

 The extension association ID. This ID is used to call other ExtensionAssociation API actions such as
 GetExtensionAssociation or DeleteExtensionAssociation.
 


extensionArn
String extensionArn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


resourceArn
String resourceArn

 The ARNs of applications, configuration profiles, or environments defined in the association.
 








Class com.amazonaws.services.appconfig.model.ExtensionSummary extends Object implements Serializable


Serialized Fields


id
String id

 The system-generated ID of the extension.
 


name
String name

 The extension name.
 


versionNumber
Integer versionNumber

 The extension version number.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


description
String description

 Information about the extension.
 








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


type
String type

 The type of configurations contained in the profile. AppConfig supports feature flags and
 freeform configurations. We recommend you create feature flag configurations to enable or disable
 new features and freeform configurations to distribute configurations to an application. When calling this API,
 enter one of the following values for Type:
 
 
 AWS.AppConfig.FeatureFlags
 
 
 AWS.Freeform
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the
 AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To
 encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that
 particular service.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 








Class com.amazonaws.services.appconfig.model.GetConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The application to get. Specify either the application name or the application ID.
 


environment
String environment

 The environment to get. Specify either the environment name or the environment ID.
 


configuration
String configuration

 The configuration to get. Specify either the configuration name or the configuration ID.
 


clientId
String clientId

 The clientId parameter in the following command is a unique, user-specified 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.
 
 
 
 AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration
 version on your clients. If you don’t send ClientConfigurationVersion with each call to
 GetConfiguration, your clients receive the current configuration. You are charged each time your
 clients receive a configuration.
 
 
 To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
 continue using GetConfiguration, we recommend that you include the
 ClientConfigurationVersion value with every call to GetConfiguration. The value to use
 for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
 by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
 GetConfiguration.
 
 
 
 For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
 








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.
 
 
 
 The Content attribute only contains data if the system finds new or updated configuration data. If
 there is no new or updated data and ClientConfigurationVersion matches the version of the current
 configuration, AppConfig returns a 204 No Content HTTP response code and the Content
 value will be empty.
 
 


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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


state
String state

 The state of the deployment.
 


eventLog
List<E> eventLog

 A list containing all events related to a deployment. The most recent events are displayed first.
 


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.
 


appliedExtensions
List<E> appliedExtensions

 A list of extensions that were processed as part of the deployment. The extensions that were previously
 associated to the configuration profile, environment, or the application when StartDeployment was
 called.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt
 secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or
 secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 








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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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 that you want 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.GetExtensionAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionAssociationId
String extensionAssociationId

 The extension association ID to get.
 








Class com.amazonaws.services.appconfig.model.GetExtensionAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID for the association.
 


extensionArn
String extensionArn

 The ARN of the extension defined in the association.
 


resourceArn
String resourceArn

 The ARNs of applications, configuration profiles, or environments defined in the association.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


parameters
Map<K,V> parameters

 The parameter names and values defined in the association.
 


extensionVersionNumber
Integer extensionVersionNumber

 The version number for the extension defined in the association.
 








Class com.amazonaws.services.appconfig.model.GetExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionIdentifier
String extensionIdentifier

 The name, the ID, or the Amazon Resource Name (ARN) of the extension.
 


versionNumber
Integer versionNumber

 The extension version number. If no version number was defined, AppConfig uses the highest version.
 








Class com.amazonaws.services.appconfig.model.GetExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID of the extension.
 


name
String name

 The extension name.
 


versionNumber
Integer versionNumber

 The extension version number.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


description
String description

 Information about the extension.
 


actions
Map<K,V> actions

 The actions defined in the extension.
 


parameters
Map<K,V> parameters

 The parameters accepted by the extension. You specify parameter values when you associate the extension to an
 AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
 these parameters are included in the Lambda request object.
 








Class com.amazonaws.services.appconfig.model.GetHostedConfigurationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


versionNumber
Integer versionNumber

 The version.
 








Class com.amazonaws.services.appconfig.model.GetHostedConfigurationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


versionNumber
Integer versionNumber

 The configuration version.
 


description
String description

 A description of the configuration.
 


content
ByteBuffer content

 The content of the configuration or the configuration data.
 


contentType
String contentType

 A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the
 configuration data in the AppConfig hosted configuration store.
 








Class com.amazonaws.services.appconfig.model.HostedConfigurationVersionSummary extends Object implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile ID.
 


versionNumber
Integer versionNumber

 The configuration version.
 


description
String description

 A description of the configuration.
 


contentType
String contentType

 A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the
 configuration data in the AppConfig hosted configuration store.
 








Class com.amazonaws.services.appconfig.model.InternalServerException extends AmazonAppConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appconfig.model.InvalidConfigurationDetail extends Object implements Serializable


Serialized Fields


constraint
String constraint

 The invalid or out-of-range validation constraint in your JSON schema that failed validation.
 


location
String location

 Location of the validation constraint in the configuration JSON schema that failed validation.
 


reason
String reason

 The reason for an invalid configuration error.
 


type
String type

 The type of error for an invalid configuration.
 


value
String value

 Details about an error with Lambda when a synchronous extension experiences an error during an invocation.
 








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. Next token is a pagination token generated by AppConfig to describe what page the
 previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls,
 the nextToken parameter should be set to the previous responses nextToken value. 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.
 


type
String type

 A filter based on the type of configurations that the configuration profile contains. A configuration can be a
 feature flag or a freeform configuration.
 








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 that may be returned for this call. If there are items that have not yet been
 returned, the response will include a non-null NextToken that you can provide in a subsequent call
 to get the next set of results.
 


nextToken
String nextToken

 The token returned by a prior call to this operation indicating the next set of results to be returned. If not
 specified, the operation will return the first 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.ListExtensionAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The ARN of an application, configuration profile, or environment.
 


extensionIdentifier
String extensionIdentifier

 The name, the ID, or the Amazon Resource Name (ARN) of the extension.
 


extensionVersionNumber
Integer extensionVersionNumber

 The version number for the extension defined in the association.
 


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 or pass null to get the first set of
 results.
 








Class com.amazonaws.services.appconfig.model.ListExtensionAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 The list of extension associations. Each item represents an extension association to an application, environment,
 or configuration profile.
 


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


name
String name

 The extension name.
 








Class com.amazonaws.services.appconfig.model.ListExtensionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 The list of available extensions. The list includes Amazon Web Services authored and user-created extensions.
 


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.ListHostedConfigurationVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


configurationProfileId
String configurationProfileId

 The configuration profile 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.
 


versionLabel
String versionLabel

 An optional filter that can be used to specify the version label of an AppConfig hosted configuration version.
 This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk
 at the end of the value, only an exact match is returned.
 








Class com.amazonaws.services.appconfig.model.ListHostedConfigurationVersionsResult 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

 Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
 


alarmRoleArn
String alarmRoleArn

 ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.
 








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


Serialized Fields


description
String description

 Information about the parameter.
 


required
Boolean required

 A parameter value must be specified in the extension association.
 


dynamic
Boolean dynamic

 Indicates whether this parameter's value can be supplied at the extension's action point instead of during
 extension association. Dynamic parameters can't be marked Required.
 








Class com.amazonaws.services.appconfig.model.PayloadTooLargeException extends AmazonAppConfigException implements Serializable

serialVersionUID:
1L



Serialized Fields


measure
String measure


limit
Float limit


size
Float size








Class com.amazonaws.services.appconfig.model.ResourceNotFoundException extends AmazonAppConfigException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName








Class com.amazonaws.services.appconfig.model.ServiceQuotaExceededException extends AmazonAppConfigException implements Serializable

serialVersionUID:
1L





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. If deploying an AppConfig hosted configuration version, you can specify
 either the version number or version label. For all other configurations, you must specify the version number.
 


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.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data
 using a customer managed key.
 


dynamicExtensionParameters
Map<K,V> dynamicExtensionParameters

 A map of dynamic extension parameter names to values to pass to associated extensions with
 PRE_START_DEPLOYMENT actions.
 








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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


state
String state

 The state of the deployment.
 


eventLog
List<E> eventLog

 A list containing all events related to a deployment. The most recent events are displayed first.
 


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.
 


appliedExtensions
List<E> appliedExtensions

 A list of extensions that were processed as part of the deployment. The extensions that were previously
 associated to the configuration profile, environment, or the application when StartDeployment was
 called.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt
 secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or
 secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 








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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


state
String state

 The state of the deployment.
 


eventLog
List<E> eventLog

 A list containing all events related to a deployment. The most recent events are displayed first.
 


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.
 


appliedExtensions
List<E> appliedExtensions

 A list of extensions that were processed as part of the deployment. The extensions that were previously
 associated to the configuration profile, environment, or the application when StartDeployment was
 called.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt
 secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or
 secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 


versionLabel
String versionLabel

 A user-defined label for an AppConfig hosted configuration version.
 








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.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The identifier for a Key Management Service key to encrypt new configuration data versions in the AppConfig
 hosted configuration store. This attribute is only used for hosted configuration types. The
 identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data
 managed in other configuration stores, see the documentation for how to specify an KMS key for that particular
 service.
 








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.
 


type
String type

 The type of configurations contained in the profile. AppConfig supports feature flags and
 freeform configurations. We recommend you create feature flag configurations to enable or disable
 new features and freeform configurations to distribute configurations to an application. When calling this API,
 enter one of the following values for Type:
 
 
 AWS.AppConfig.FeatureFlags
 
 
 AWS.Freeform
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the
 AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To
 encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that
 particular service.
 


kmsKeyIdentifier
String kmsKeyIdentifier

 The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created
 or updated.
 








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 that AppConfig monitors for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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. AppConfig supports the following growth types:
 
 
 Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly
 distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially
 makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed,
 the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the
 deployed configuration.
 
 
 Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
 G*(2^N). In this formula, G is the growth factor specified by the user and
 N is the number of steps until the configuration is deployed to all targets. For example, if you
 specify a growth factor of 2, then the system rolls out the configuration as follows:
 
 
 2*(2^0)
 
 
 2*(2^1)
 
 
 2*(2^2)
 
 
 Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the
 targets, and continues until the configuration has been deployed to all targets.
 








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 that AppConfig monitored for alarms before considering the deployment to be complete and no
 longer eligible for automatic rollback.
 


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.UpdateExtensionAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionAssociationId
String extensionAssociationId

 The system-generated ID for the association.
 


parameters
Map<K,V> parameters

 The parameter names and values defined in the extension.
 








Class com.amazonaws.services.appconfig.model.UpdateExtensionAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID for the association.
 


extensionArn
String extensionArn

 The ARN of the extension defined in the association.
 


resourceArn
String resourceArn

 The ARNs of applications, configuration profiles, or environments defined in the association.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


parameters
Map<K,V> parameters

 The parameter names and values defined in the association.
 


extensionVersionNumber
Integer extensionVersionNumber

 The version number for the extension defined in the association.
 








Class com.amazonaws.services.appconfig.model.UpdateExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


extensionIdentifier
String extensionIdentifier

 The name, the ID, or the Amazon Resource Name (ARN) of the extension.
 


description
String description

 Information about the extension.
 


actions
Map<K,V> actions

 The actions defined in the extension.
 


parameters
Map<K,V> parameters

 One or more parameters for the actions called by the extension.
 


versionNumber
Integer versionNumber

 The extension version number.
 








Class com.amazonaws.services.appconfig.model.UpdateExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The system-generated ID of the extension.
 


name
String name

 The extension name.
 


versionNumber
Integer versionNumber

 The extension version number.
 


arn
String arn

 The system-generated Amazon Resource Name (ARN) for the extension.
 


description
String description

 Information about the extension.
 


actions
Map<K,V> actions

 The actions defined in the extension.
 


parameters
Map<K,V> parameters

 The parameters accepted by the extension. You specify parameter values when you associate the extension to an
 AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions,
 these parameters are included in the Lambda request object.
 








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 the Amazon Resource Name (ARN) of an Lambda function.
 








Package com.amazonaws.services.appconfigdata.model




Class com.amazonaws.services.appconfigdata.model.AWSAppConfigDataException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appconfigdata.model.BadRequestDetails extends Object implements Serializable


Serialized Fields


invalidParameters
Map<K,V> invalidParameters

 One or more specified parameters are not valid for the call.
 








Class com.amazonaws.services.appconfigdata.model.BadRequestException extends AWSAppConfigDataException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason

 Code indicating the reason the request was invalid.
 


details
BadRequestDetails details

 Details describing why the request was invalid.
 








Class com.amazonaws.services.appconfigdata.model.GetLatestConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationToken
String configurationToken

 Token describing the current state of the configuration session. To obtain a token, first call the
 StartConfigurationSession API. Note that every call to GetLatestConfiguration will return a
 new ConfigurationToken (NextPollConfigurationToken in the response) and must be
 provided to subsequent GetLatestConfiguration API calls.
 
 
 
 This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a
 GetLatestConfiguration call uses an expired token, the system returns
 BadRequestException.
 
 








Class com.amazonaws.services.appconfigdata.model.GetLatestConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextPollConfigurationToken
String nextPollConfigurationToken

 The latest token describing the current state of the configuration session. This must be provided to the
 next call to GetLatestConfiguration.
 
 
 
 This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a
 GetLatestConfiguration call uses an expired token, the system returns
 BadRequestException.
 
 


nextPollIntervalInSeconds
Integer nextPollIntervalInSeconds

 The amount of time the client should wait before polling for configuration updates again. Use
 RequiredMinimumPollIntervalInSeconds to set the desired poll interval.
 


contentType
String contentType

 A standard MIME type describing the format of the configuration content.
 


configuration
ByteBuffer configuration

 The data of the configuration. This may be empty if the client already has the latest version of configuration.
 


versionLabel
String versionLabel

 The user-defined label for the AppConfig hosted configuration version. This attribute doesn't apply if the
 configuration is not from an AppConfig hosted configuration version. If the client already has the latest version
 of the configuration data, this value is empty.
 








Class com.amazonaws.services.appconfigdata.model.InternalServerException extends AWSAppConfigDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appconfigdata.model.InvalidParameterDetail extends Object implements Serializable


Serialized Fields


problem
String problem

 The reason the parameter is invalid.
 








Class com.amazonaws.services.appconfigdata.model.ResourceNotFoundException extends AWSAppConfigDataException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceType
String resourceType

 The type of resource that was not found.
 


referencedBy
Map<K,V> referencedBy

 A map indicating which parameters in the request reference the resource that was not found.
 








Class com.amazonaws.services.appconfigdata.model.StartConfigurationSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationIdentifier
String applicationIdentifier

 The application ID or the application name.
 


environmentIdentifier
String environmentIdentifier

 The environment ID or the environment name.
 


configurationProfileIdentifier
String configurationProfileIdentifier

 The configuration profile ID or the configuration profile name.
 


requiredMinimumPollIntervalInSeconds
Integer requiredMinimumPollIntervalInSeconds

 Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that
 established the session can't call GetLatestConfiguration more frequently than every 60 seconds.
 








Class com.amazonaws.services.appconfigdata.model.StartConfigurationSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


initialConfigurationToken
String initialConfigurationToken

 Token encapsulating state about the configuration session. Provide this token to the
 GetLatestConfiguration API to retrieve configuration data.
 
 
 
 This token should only be used once in your first call to GetLatestConfiguration. You must
 use the new token in the GetLatestConfiguration response (NextPollConfigurationToken)
 in each subsequent call to GetLatestConfiguration.
 
 
 The InitialConfigurationToken and NextPollConfigurationToken should only be used once.
 To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration
 call uses an expired token, the system returns BadRequestException.
 
 








Class com.amazonaws.services.appconfigdata.model.ThrottlingException extends AWSAppConfigDataException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.appfabric.model




Class com.amazonaws.services.appfabric.model.AccessDeniedException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appfabric.model.ApiKeyCredential extends Object implements Serializable


Serialized Fields


apiKey
String apiKey

 An API key for an application.
 








Class com.amazonaws.services.appfabric.model.AppAuthorization extends Object implements Serializable


Serialized Fields


appAuthorizationArn
String appAuthorizationArn

 The Amazon Resource Name (ARN) of the app authorization.
 


appBundleArn
String appBundleArn

 The Amazon Resource Name (ARN) of the app bundle for the app authorization.
 


app
String app

 The name of the application.
 


tenant
Tenant tenant

 Contains information about an application tenant, such as the application display name and identifier.
 


authType
String authType

 The authorization type.
 


status
String status

 The state of the app authorization.
 
 
 The following states are possible:
 
 
 
 
 PendingConnect: The initial state of the app authorization. The app authorization is created but not
 yet connected.
 
 
 
 
 Connected: The app authorization is connected to the application, and is ready to be used.
 
 
 
 
 ConnectionValidationFailed: The app authorization received a validation exception when trying to
 connect to the application. If the app authorization is in this state, you should verify the configured
 credentials and try to connect the app authorization again.
 
 
 
 
 TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is
 in this state, you should try to reconnect the app authorization.
 
 
 


createdAt
Date createdAt

 The timestamp of when the app authorization was created.
 


updatedAt
Date updatedAt

 The timestamp of when the app authorization was last updated.
 


persona
String persona

 The user persona of the app authorization.
 
 
 This field should always be admin.
 


authUrl
String authUrl

 The application URL for the OAuth flow.
 








Class com.amazonaws.services.appfabric.model.AppAuthorizationSummary extends Object implements Serializable


Serialized Fields


appAuthorizationArn
String appAuthorizationArn

 The Amazon Resource Name (ARN) of the app authorization.
 


appBundleArn
String appBundleArn

 The Amazon Resource Name (ARN) of the app bundle for the app authorization.
 


app
String app

 The name of the application.
 


tenant
Tenant tenant

 Contains information about an application tenant, such as the application display name and identifier.
 


status
String status

 The state of the app authorization.
 
 
 The following states are possible:
 
 
 
 
 PendingConnect: The initial state of the app authorization. The app authorization is created but not
 yet connected.
 
 
 
 
 Connected: The app authorization is connected to the application, and is ready to be used.
 
 
 
 
 ConnectionValidationFailed: The app authorization received a validation exception when trying to
 connect to the application. If the app authorization is in this state, you should verify the configured
 credentials and try to connect the app authorization again.
 
 
 
 
 TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is
 in this state, you should try to reconnect the app authorization.
 
 
 


updatedAt
Date updatedAt

 Timestamp for when the app authorization was last updated.
 








Class com.amazonaws.services.appfabric.model.AppBundle extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the app bundle.
 


customerManagedKeyArn
String customerManagedKeyArn

 The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data.
 








Class com.amazonaws.services.appfabric.model.AppBundleSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the app bundle.
 








Class com.amazonaws.services.appfabric.model.AuditLogDestinationConfiguration extends Object implements Serializable


Serialized Fields


destination
Destination destination

 Contains information about an audit log destination.
 








Class com.amazonaws.services.appfabric.model.AuditLogProcessingConfiguration extends Object implements Serializable


Serialized Fields


schema
String schema

 The event schema in which the audit logs need to be formatted.
 


format
String format

 The format in which the audit logs need to be formatted.
 








Class com.amazonaws.services.appfabric.model.AuthRequest extends Object implements Serializable


Serialized Fields


redirectUri
String redirectUri

 The redirect URL that is specified in the AuthURL and the application client.
 


code
String code

 The authorization code returned by the application after permission is granted in the application OAuth page
 (after clicking on the AuthURL).
 








Class com.amazonaws.services.appfabric.model.AWSAppFabricException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appfabric.model.BatchGetUserAccessTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


taskIdList
List<E> taskIdList

 The tasks IDs to use for the request.
 








Class com.amazonaws.services.appfabric.model.BatchGetUserAccessTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userAccessResultsList
List<E> userAccessResultsList

 Contains a list of user access results.
 








Class com.amazonaws.services.appfabric.model.ConflictException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The resource ID.
 


resourceType
String resourceType

 The resource type.
 








Class com.amazonaws.services.appfabric.model.ConnectAppAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app
 authorization to use for the request.
 


appAuthorizationIdentifier
String appAuthorizationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the
 request.
 


authRequest
AuthRequest authRequest

 Contains OAuth2 authorization information.
 
 
 This is required if the app authorization for the request is configured with an OAuth2 (oauth2)
 authorization type.
 








Class com.amazonaws.services.appfabric.model.ConnectAppAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appAuthorizationSummary
AppAuthorizationSummary appAuthorizationSummary

 Contains a summary of the app authorization.
 








Class com.amazonaws.services.appfabric.model.CreateAppAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


app
String app

 The name of the application.
 
 
 Valid values are:
 
 
 
 
 SLACK
 
 
 
 
 ASANA
 
 
 
 
 JIRA
 
 
 
 
 M365
 
 
 
 
 M365AUDITLOGS
 
 
 
 
 ZOOM
 
 
 
 
 ZENDESK
 
 
 
 
 OKTA
 
 
 
 
 GOOGLE
 
 
 
 
 DROPBOX
 
 
 
 
 SMARTSHEET
 
 
 
 
 CISCO
 
 
 


credential
Credential credential

 Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
 
 
 Specify credentials that match the authorization type for your request. For example, if the authorization type
 for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
 


tenant
Tenant tenant

 Contains information about an application tenant, such as the application display name and identifier.
 


authType
String authType

 The authorization type for the app authorization.
 


clientToken
String clientToken

 Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
 lets you safely retry the request without accidentally performing the same operation a second time. Passing the
 same value to a later call to an operation requires that you also pass the same value for all other parameters.
 We recommend that you use a UUID type of
 value.
 
 
 If you don't provide this value, then Amazon Web Services generates a random one for you.
 
 
 If you retry the operation with the same ClientToken, but with different parameters, the retry fails
 with an IdempotentParameterMismatch error.
 


tags
List<E> tags

 A map of the key-value pairs of the tag or tags to assign to the resource.
 








Class com.amazonaws.services.appfabric.model.CreateAppAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appAuthorization
AppAuthorization appAuthorization

 Contains information about an app authorization.
 








Class com.amazonaws.services.appfabric.model.CreateAppBundleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
 lets you safely retry the request without accidentally performing the same operation a second time. Passing the
 same value to a later call to an operation requires that you also pass the same value for all other parameters.
 We recommend that you use a UUID type of
 value.
 
 
 If you don't provide this value, then Amazon Web Services generates a random one for you.
 
 
 If you retry the operation with the same ClientToken, but with different parameters, the retry fails
 with an IdempotentParameterMismatch error.
 


customerManagedKeyIdentifier
String customerManagedKeyIdentifier

 The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If
 this is not specified, an Amazon Web Services owned key is used for encryption.
 


tags
List<E> tags

 A map of the key-value pairs of the tag or tags to assign to the resource.
 








Class com.amazonaws.services.appfabric.model.CreateAppBundleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBundle
AppBundle appBundle

 Contains information about an app bundle.
 








Class com.amazonaws.services.appfabric.model.CreateIngestionDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 Contains information about how ingested data is processed.
 


destinationConfiguration
DestinationConfiguration destinationConfiguration

 Contains information about the destination of ingested data.
 


clientToken
String clientToken

 Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
 lets you safely retry the request without accidentally performing the same operation a second time. Passing the
 same value to a later call to an operation requires that you also pass the same value for all other parameters.
 We recommend that you use a UUID type of
 value.
 
 
 If you don't provide this value, then Amazon Web Services generates a random one for you.
 
 
 If you retry the operation with the same ClientToken, but with different parameters, the retry fails
 with an IdempotentParameterMismatch error.
 


tags
List<E> tags

 A map of the key-value pairs of the tag or tags to assign to the resource.
 








Class com.amazonaws.services.appfabric.model.CreateIngestionDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestionDestination
IngestionDestination ingestionDestination

 Contains information about an ingestion destination.
 








Class com.amazonaws.services.appfabric.model.CreateIngestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


app
String app

 The name of the application.
 
 
 Valid values are:
 
 
 
 
 SLACK
 
 
 
 
 ASANA
 
 
 
 
 JIRA
 
 
 
 
 M365
 
 
 
 
 M365AUDITLOGS
 
 
 
 
 ZOOM
 
 
 
 
 ZENDESK
 
 
 
 
 OKTA
 
 
 
 
 GOOGLE
 
 
 
 
 DROPBOX
 
 
 
 
 SMARTSHEET
 
 
 
 
 CISCO
 
 
 


tenantId
String tenantId

 The ID of the application tenant.
 


ingestionType
String ingestionType

 The ingestion type.
 


clientToken
String clientToken

 Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
 lets you safely retry the request without accidentally performing the same operation a second time. Passing the
 same value to a later call to an operation requires that you also pass the same value for all other parameters.
 We recommend that you use a UUID type of
 value.
 
 
 If you don't provide this value, then Amazon Web Services generates a random one for you.
 
 
 If you retry the operation with the same ClientToken, but with different parameters, the retry fails
 with an IdempotentParameterMismatch error.
 


tags
List<E> tags

 A map of the key-value pairs of the tag or tags to assign to the resource.
 








Class com.amazonaws.services.appfabric.model.CreateIngestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestion
Ingestion ingestion

 Contains information about an ingestion.
 








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


Serialized Fields


oauth2Credential
Oauth2Credential oauth2Credential

 Contains OAuth2 client credential information.
 


apiKeyCredential
ApiKeyCredential apiKeyCredential

 Contains API key credential information.
 








Class com.amazonaws.services.appfabric.model.DeleteAppAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


appAuthorizationIdentifier
String appAuthorizationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the
 request.
 








Class com.amazonaws.services.appfabric.model.DeleteAppAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.DeleteAppBundleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
 








Class com.amazonaws.services.appfabric.model.DeleteAppBundleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.DeleteIngestionDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


ingestionDestinationIdentifier
String ingestionDestinationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the
 request.
 








Class com.amazonaws.services.appfabric.model.DeleteIngestionDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.DeleteIngestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 








Class com.amazonaws.services.appfabric.model.DeleteIngestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.Destination extends Object implements Serializable


Serialized Fields


s3Bucket
S3Bucket s3Bucket

 Contains information about an Amazon S3 bucket.
 


firehoseStream
FirehoseStream firehoseStream

 Contains information about an Amazon Kinesis Data Firehose delivery stream.
 








Class com.amazonaws.services.appfabric.model.DestinationConfiguration extends Object implements Serializable


Serialized Fields


auditLog
AuditLogDestinationConfiguration auditLog

 Contains information about an audit log destination configuration.
 








Class com.amazonaws.services.appfabric.model.FirehoseStream extends Object implements Serializable


Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis Data Firehose delivery stream.
 








Class com.amazonaws.services.appfabric.model.GetAppAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


appAuthorizationIdentifier
String appAuthorizationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the
 request.
 








Class com.amazonaws.services.appfabric.model.GetAppAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appAuthorization
AppAuthorization appAuthorization

 Contains information about an app authorization.
 








Class com.amazonaws.services.appfabric.model.GetAppBundleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 








Class com.amazonaws.services.appfabric.model.GetAppBundleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBundle
AppBundle appBundle

 Contains information about an app bundle.
 








Class com.amazonaws.services.appfabric.model.GetIngestionDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


ingestionDestinationIdentifier
String ingestionDestinationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the
 request.
 








Class com.amazonaws.services.appfabric.model.GetIngestionDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestionDestination
IngestionDestination ingestionDestination

 Contains information about an ingestion destination.
 








Class com.amazonaws.services.appfabric.model.GetIngestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 








Class com.amazonaws.services.appfabric.model.GetIngestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestion
Ingestion ingestion

 Contains information about an ingestion.
 








Class com.amazonaws.services.appfabric.model.Ingestion extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the ingestion.
 


appBundleArn
String appBundleArn

 The Amazon Resource Name (ARN) of the app bundle for the ingestion.
 


app
String app

 The name of the application.
 


tenantId
String tenantId

 The ID of the application tenant.
 


createdAt
Date createdAt

 The timestamp of when the ingestion was created.
 


updatedAt
Date updatedAt

 The timestamp of when the ingestion was last updated.
 


state
String state

 The status of the ingestion.
 


ingestionType
String ingestionType

 The type of the ingestion.
 








Class com.amazonaws.services.appfabric.model.IngestionDestination extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the ingestion destination.
 


ingestionArn
String ingestionArn

 The Amazon Resource Name (ARN) of the ingestion.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 Contains information about how ingested data is processed.
 


destinationConfiguration
DestinationConfiguration destinationConfiguration

 Contains information about the destination of ingested data.
 


status
String status

 The state of the ingestion destination.
 
 
 The following states are possible:
 
 
 
 
 Active: The ingestion destination is active and is ready to be used.
 
 
 
 
 Failed: The ingestion destination has failed. If the ingestion destination is in this state, you
 should verify the ingestion destination configuration and try again.
 
 
 


statusReason
String statusReason

 The reason for the current status of the ingestion destination.
 
 
 Only present when the status of ingestion destination is Failed.
 


createdAt
Date createdAt

 The timestamp of when the ingestion destination was created.
 


updatedAt
Date updatedAt

 The timestamp of when the ingestion destination was last updated.
 








Class com.amazonaws.services.appfabric.model.IngestionDestinationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the ingestion destination.
 








Class com.amazonaws.services.appfabric.model.IngestionSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the ingestion.
 


app
String app

 The name of the application.
 


tenantId
String tenantId

 The ID of the application tenant.
 


state
String state

 The status of the ingestion.
 








Class com.amazonaws.services.appfabric.model.InternalServerException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
Integer retryAfterSeconds

 The period of time after which you should retry your request.
 








Class com.amazonaws.services.appfabric.model.ListAppAuthorizationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


maxResults
Integer maxResults

 The maximum number of results that are returned per call. You can use nextToken to obtain further
 pages of results.
 
 
 This is only an upper limit. The actual number of results returned per call might be fewer than the specified
 maximum.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListAppAuthorizationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appAuthorizationSummaryList
List<E> appAuthorizationSummaryList

 Contains a list of app authorization summaries.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListAppBundlesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results that are returned per call. You can use nextToken to obtain further
 pages of results.
 
 
 This is only an upper limit. The actual number of results returned per call might be fewer than the specified
 maximum.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListAppBundlesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBundleSummaryList
List<E> appBundleSummaryList

 Contains a list of app bundle summaries.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListIngestionDestinationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


maxResults
Integer maxResults

 The maximum number of results that are returned per call. You can use nextToken to obtain further
 pages of results.
 
 
 This is only an upper limit. The actual number of results returned per call might be fewer than the specified
 maximum.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListIngestionDestinationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestionDestinations
List<E> ingestionDestinations

 Contains a list of ingestion destination summaries.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListIngestionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


maxResults
Integer maxResults

 The maximum number of results that are returned per call. You can use nextToken to obtain further
 pages of results.
 
 
 This is only an upper limit. The actual number of results returned per call might be fewer than the specified
 maximum.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








Class com.amazonaws.services.appfabric.model.ListIngestionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestions
List<E> ingestions

 Contains a list of ingestion summaries.
 


nextToken
String nextToken

 If nextToken is returned, there are more results available. The value of nextToken is a
 unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
 Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
 token will return an HTTP 400 InvalidToken error.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
 








Class com.amazonaws.services.appfabric.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A map of the key-value pairs for the tag or tags assigned to the specified resource.
 








Class com.amazonaws.services.appfabric.model.Oauth2Credential extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The client ID of the client application.
 


clientSecret
String clientSecret

 The client secret of the client application.
 








Class com.amazonaws.services.appfabric.model.ProcessingConfiguration extends Object implements Serializable


Serialized Fields


auditLog
AuditLogProcessingConfiguration auditLog

 Contains information about an audit log processing configuration.
 








Class com.amazonaws.services.appfabric.model.ResourceNotFoundException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The resource ID.
 


resourceType
String resourceType

 The resource type.
 








Class com.amazonaws.services.appfabric.model.S3Bucket extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the Amazon S3 bucket.
 


prefix
String prefix

 The object key to use.
 








Class com.amazonaws.services.appfabric.model.ServiceQuotaExceededException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The resource ID.
 


resourceType
String resourceType

 The resource type.
 


serviceCode
String serviceCode

 The code of the service.
 


quotaCode
String quotaCode

 The code for the quota exceeded.
 








Class com.amazonaws.services.appfabric.model.StartIngestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 








Class com.amazonaws.services.appfabric.model.StartIngestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.StartUserAccessTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


email
String email

 The email address of the target user.
 








Class com.amazonaws.services.appfabric.model.StartUserAccessTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userAccessTasksList
List<E> userAccessTasksList

 Contains a list of user access task information.
 








Class com.amazonaws.services.appfabric.model.StopIngestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 








Class com.amazonaws.services.appfabric.model.StopIngestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Tag key.
 


value
String value

 Tag value.
 








Class com.amazonaws.services.appfabric.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to tag.
 


tags
List<E> tags

 A map of the key-value pairs of the tag or tags to assign to the resource.
 








Class com.amazonaws.services.appfabric.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.TaskError extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The code of the error.
 


errorMessage
String errorMessage

 The message of the error.
 








Class com.amazonaws.services.appfabric.model.Tenant extends Object implements Serializable


Serialized Fields


tenantIdentifier
String tenantIdentifier

 The ID of the application tenant.
 


tenantDisplayName
String tenantDisplayName

 The display name of the tenant.
 








Class com.amazonaws.services.appfabric.model.ThrottlingException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


serviceCode
String serviceCode

 The code of the service.
 


quotaCode
String quotaCode

 The code for the quota exceeded.
 


retryAfterSeconds
Integer retryAfterSeconds

 The period of time after which you should retry your request.
 








Class com.amazonaws.services.appfabric.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to untag.
 


tagKeys
List<E> tagKeys

 The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
 








Class com.amazonaws.services.appfabric.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appfabric.model.UpdateAppAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


appAuthorizationIdentifier
String appAuthorizationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the
 request.
 


credential
Credential credential

 Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
 
 
 Specify credentials that match the authorization type of the app authorization to update. For example, if the
 authorization type of the app authorization is OAuth2 (oauth2), then you should provide only the
 OAuth2 credentials.
 


tenant
Tenant tenant

 Contains information about an application tenant, such as the application display name and identifier.
 








Class com.amazonaws.services.appfabric.model.UpdateAppAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appAuthorization
AppAuthorization appAuthorization

 Contains information about an app authorization.
 








Class com.amazonaws.services.appfabric.model.UpdateIngestionDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBundleIdentifier
String appBundleIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
 


ingestionIdentifier
String ingestionIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
 


ingestionDestinationIdentifier
String ingestionDestinationIdentifier

 The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the
 request.
 


destinationConfiguration
DestinationConfiguration destinationConfiguration

 Contains information about the destination of ingested data.
 








Class com.amazonaws.services.appfabric.model.UpdateIngestionDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ingestionDestination
IngestionDestination ingestionDestination

 Contains information about an ingestion destination.
 








Class com.amazonaws.services.appfabric.model.UserAccessResultItem extends Object implements Serializable


Serialized Fields


app
String app

 The name of the application.
 


tenantId
String tenantId

 The ID of the application tenant.
 


tenantDisplayName
String tenantDisplayName

 The display name of the tenant.
 


taskId
String taskId

 The unique ID of the task.
 


resultStatus
String resultStatus

 The status of the user access result item.
 
 
 The following states are possible:
 
 
 
 
 IN_PROGRESS: The user access task is in progress.
 
 
 
 
 COMPLETED: The user access task completed successfully.
 
 
 
 
 FAILED: The user access task failed.
 
 
 
 
 EXPIRED: The user access task expired.
 
 
 


email
String email

 The email address of the target user.
 


userId
String userId

 The unique ID of user.
 


userFullName
String userFullName

 The full name of the user.
 


userFirstName
String userFirstName

 The first name of the user.
 


userLastName
String userLastName

 The last name of the user.
 


userStatus
String userStatus

 The status of the user returned by the application.
 


taskError
TaskError taskError

 Contains information about an error returned from a user access task.
 








Class com.amazonaws.services.appfabric.model.UserAccessTaskItem extends Object implements Serializable


Serialized Fields


app
String app

 The name of the application.
 


tenantId
String tenantId

 The ID of the application tenant.
 


taskId
String taskId

 The unique ID of the task.
 


error
TaskError error

 Error from the task, if any.
 








Class com.amazonaws.services.appfabric.model.ValidationException extends AWSAppFabricException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason

 The reason for the exception.
 


fieldList
List<E> fieldList

 The field list.
 








Class com.amazonaws.services.appfabric.model.ValidationExceptionField extends Object implements Serializable


Serialized Fields


name
String name

 The field name where the invalid entry was detected.
 


message
String message

 A message about the validation exception.
 








Package com.amazonaws.services.appflow.model




Class com.amazonaws.services.appflow.model.AccessDeniedException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.AggregationConfig extends Object implements Serializable


Serialized Fields


aggregationType
String aggregationType

 Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
 


targetFileSize
Long targetFileSize

 The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each
 file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this
 target based on the number and size of the records that each file contains.
 








Class com.amazonaws.services.appflow.model.AmazonAppflowException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.AmplitudeConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


apiKey
String apiKey

 A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
 


secretKey
String secretKey

 The Secret Access Key portion of the credentials.
 








Class com.amazonaws.services.appflow.model.AmplitudeConnectorProfileProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.AmplitudeMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.AmplitudeSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Amplitude flow source.
 








Class com.amazonaws.services.appflow.model.ApiKeyCredentials extends Object implements Serializable


Serialized Fields


apiKey
String apiKey

 The API key required for API key authentication.
 


apiSecretKey
String apiSecretKey

 The API secret key required for API key authentication.
 








Class com.amazonaws.services.appflow.model.AuthenticationConfig extends Object implements Serializable


Serialized Fields


isBasicAuthSupported
Boolean isBasicAuthSupported

 Indicates whether basic authentication is supported by the connector.
 


isApiKeyAuthSupported
Boolean isApiKeyAuthSupported

 Indicates whether API key authentication is supported by the connector
 


isOAuth2Supported
Boolean isOAuth2Supported

 Indicates whether OAuth 2.0 authentication is supported by the connector.
 


isCustomAuthSupported
Boolean isCustomAuthSupported

 Indicates whether custom authentication is supported by the connector
 


oAuth2Defaults
OAuth2Defaults oAuth2Defaults

 Contains the default values required for OAuth 2.0 authentication.
 


customAuthConfigs
List<E> customAuthConfigs

 Contains information required for custom authentication.
 








Class com.amazonaws.services.appflow.model.AuthParameter extends Object implements Serializable


Serialized Fields


key
String key

 The authentication key required to authenticate with the connector.
 


isRequired
Boolean isRequired

 Indicates whether this authentication parameter is required.
 


label
String label

 Label used for authentication parameter.
 


description
String description

 A description about the authentication parameter.
 


isSensitiveField
Boolean isSensitiveField

 Indicates whether this authentication parameter is a sensitive field.
 


connectorSuppliedValues
List<E> connectorSuppliedValues

 Contains default values for this authentication parameter that are supplied by the connector.
 








Class com.amazonaws.services.appflow.model.BasicAuthCredentials extends Object implements Serializable


Serialized Fields


username
String username

 The username to use to connect to a resource.
 


password
String password

 The password to use to connect to a resource.
 








Class com.amazonaws.services.appflow.model.CancelFlowExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The name of a flow with active runs that you want to cancel.
 


executionIds
List<E> executionIds

 The ID of each active run to cancel. These runs must belong to the flow you specify in your request.
 
 
 If you omit this parameter, your request ends all active runs that belong to the flow.
 








Class com.amazonaws.services.appflow.model.CancelFlowExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invalidExecutions
List<E> invalidExecutions

 The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible for canceling because they
 haven't started yet or have already completed.
 








Class com.amazonaws.services.appflow.model.ConflictException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.ConnectorAuthenticationException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.ConnectorConfiguration extends Object implements Serializable


Serialized Fields


canUseAsSource
Boolean canUseAsSource

 Specifies whether the connector can be used as a source.
 


canUseAsDestination
Boolean canUseAsDestination

 Specifies whether the connector can be used as a destination.
 


supportedDestinationConnectors
List<E> supportedDestinationConnectors

 Lists the connectors that are available for use as destinations.
 


supportedSchedulingFrequencies
List<E> supportedSchedulingFrequencies

 Specifies the supported flow frequency for that connector.
 


isPrivateLinkEnabled
Boolean isPrivateLinkEnabled

 Specifies if PrivateLink is enabled for that connector.
 


isPrivateLinkEndpointUrlRequired
Boolean isPrivateLinkEndpointUrlRequired

 Specifies if a PrivateLink endpoint URL is required.
 


supportedTriggerTypes
List<E> supportedTriggerTypes

 Specifies the supported trigger types for the flow.
 


connectorMetadata
ConnectorMetadata connectorMetadata

 Specifies connector-specific metadata such as oAuthScopes, supportedRegions,
 privateLinkServiceUrl, and so on.
 


connectorType
String connectorType

 The connector type.
 


connectorLabel
String connectorLabel

 The label used for registering the connector.
 


connectorDescription
String connectorDescription

 A description about the connector.
 


connectorOwner
String connectorOwner

 The owner who developed the connector.
 


connectorName
String connectorName

 The connector name.
 


connectorVersion
String connectorVersion

 The connector version.
 


connectorArn
String connectorArn

 The Amazon Resource Name (ARN) for the registered connector.
 


connectorModes
List<E> connectorModes

 The connection modes that the connector supports.
 


authenticationConfig
AuthenticationConfig authenticationConfig

 The authentication config required for the connector.
 


connectorRuntimeSettings
List<E> connectorRuntimeSettings

 The required connector runtime settings.
 


supportedApiVersions
List<E> supportedApiVersions

 A list of API versions that are supported by the connector.
 


supportedOperators
List<E> supportedOperators

 A list of operators supported by the connector.
 


supportedWriteOperations
List<E> supportedWriteOperations

 A list of write operations supported by the connector.
 


connectorProvisioningType
String connectorProvisioningType

 The provisioning type used to register the connector.
 


connectorProvisioningConfig
ConnectorProvisioningConfig connectorProvisioningConfig

 The configuration required for registering the connector.
 


logoURL
String logoURL

 Logo URL of the connector.
 


registeredAt
Date registeredAt

 The date on which the connector was registered.
 


registeredBy
String registeredBy

 Information about who registered the connector.
 


supportedDataTransferTypes
List<E> supportedDataTransferTypes

 The data transfer types that the connector supports.
 
 
 RECORD
 
 
 Structured records.
 
 
 FILE
 
 
 Files or binary data.
 
 
 


supportedDataTransferApis
List<E> supportedDataTransferApis

 The APIs of the connector application that Amazon AppFlow can use to transfer your data.
 








Class com.amazonaws.services.appflow.model.ConnectorDetail extends Object implements Serializable


Serialized Fields


connectorDescription
String connectorDescription

 A description about the registered connector.
 


connectorName
String connectorName

 The name of the connector.
 


connectorOwner
String connectorOwner

 The owner of the connector.
 


connectorVersion
String connectorVersion

 The connector version.
 


applicationType
String applicationType

 The application type of the connector.
 


connectorType
String connectorType

 The connector type.
 


connectorLabel
String connectorLabel

 A label used for the connector.
 


registeredAt
Date registeredAt

 The time at which the connector was registered.
 


registeredBy
String registeredBy

 The user who registered the connector.
 


connectorProvisioningType
String connectorProvisioningType

 The provisioning type that the connector uses.
 


connectorModes
List<E> connectorModes

 The connection mode that the connector supports.
 


supportedDataTransferTypes
List<E> supportedDataTransferTypes

 The data transfer types that the connector supports.
 
 
 RECORD
 
 
 Structured records.
 
 
 FILE
 
 
 Files or binary data.
 
 
 








Class com.amazonaws.services.appflow.model.ConnectorEntity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the connector entity.
 


label
String label

 The label applied to the connector entity.
 


hasNestedEntities
Boolean hasNestedEntities

 Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If
 another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then
 it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a
 recursive fashion.
 








Class com.amazonaws.services.appflow.model.ConnectorEntityField extends Object implements Serializable


Serialized Fields


identifier
String identifier

 The unique identifier of the connector field.
 


parentIdentifier
String parentIdentifier

 The parent identifier of the connector field.
 


label
String label

 The label applied to a connector entity field.
 


isPrimaryKey
Boolean isPrimaryKey

 Booelan value that indicates whether this field can be used as a primary key.
 


defaultValue
String defaultValue

 Default value that can be assigned to this field.
 


isDeprecated
Boolean isDeprecated

 Booelan value that indicates whether this field is deprecated or not.
 


supportedFieldTypeDetails
SupportedFieldTypeDetails supportedFieldTypeDetails

 Contains details regarding the supported FieldType, including the corresponding
 filterOperators and supportedValues.
 


description
String description

 A description of the connector entity field.
 


sourceProperties
SourceFieldProperties sourceProperties

 The properties that can be applied to a field when the connector is being used as a source.
 


destinationProperties
DestinationFieldProperties destinationProperties

 The properties applied to a field when the connector is being used as a destination.
 


customProperties
Map<K,V> customProperties

 A map that has specific properties related to the ConnectorEntityField.
 








Class com.amazonaws.services.appflow.model.ConnectorMetadata extends Object implements Serializable


Serialized Fields


amplitude
AmplitudeMetadata amplitude

 The connector metadata specific to Amplitude.
 


datadog
DatadogMetadata datadog

 The connector metadata specific to Datadog.
 


dynatrace
DynatraceMetadata dynatrace

 The connector metadata specific to Dynatrace.
 


googleAnalytics
GoogleAnalyticsMetadata googleAnalytics

 The connector metadata specific to Google Analytics.
 


inforNexus
InforNexusMetadata inforNexus

 The connector metadata specific to Infor Nexus.
 


marketo
MarketoMetadata marketo

 The connector metadata specific to Marketo.
 


redshift
RedshiftMetadata redshift

 The connector metadata specific to Amazon Redshift.
 


s3
S3Metadata s3

 The connector metadata specific to Amazon S3.
 


salesforce
SalesforceMetadata salesforce

 The connector metadata specific to Salesforce.
 


serviceNow
ServiceNowMetadata serviceNow

 The connector metadata specific to ServiceNow.
 


singular
SingularMetadata singular

 The connector metadata specific to Singular.
 


slack
SlackMetadata slack

 The connector metadata specific to Slack.
 


snowflake
SnowflakeMetadata snowflake

 The connector metadata specific to Snowflake.
 


trendmicro
TrendmicroMetadata trendmicro

 The connector metadata specific to Trend Micro.
 


veeva
VeevaMetadata veeva

 The connector metadata specific to Veeva.
 


zendesk
ZendeskMetadata zendesk

 The connector metadata specific to Zendesk.
 


eventBridge
EventBridgeMetadata eventBridge

 The connector metadata specific to Amazon EventBridge.
 


upsolver
UpsolverMetadata upsolver

 The connector metadata specific to Upsolver.
 


customerProfiles
CustomerProfilesMetadata customerProfiles

 The connector metadata specific to Amazon Connect Customer Profiles.
 


honeycode
HoneycodeMetadata honeycode

 The connector metadata specific to Amazon Honeycode.
 


sAPOData
SAPODataMetadata sAPOData


pardot
PardotMetadata pardot

 The connector metadata specific to Salesforce Pardot.
 








Class com.amazonaws.services.appflow.model.ConnectorOAuthRequest extends Object implements Serializable


Serialized Fields


authCode
String authCode

 The code provided by the connector when it has been authenticated via the connected app.
 


redirectUri
String redirectUri

 The URL to which the authentication server redirects the browser after authorization has been granted.
 








Class com.amazonaws.services.appflow.model.ConnectorOperator extends Object implements Serializable


Serialized Fields


amplitude
String amplitude

 The operation to be performed on the provided Amplitude source fields.
 


datadog
String datadog

 The operation to be performed on the provided Datadog source fields.
 


dynatrace
String dynatrace

 The operation to be performed on the provided Dynatrace source fields.
 


googleAnalytics
String googleAnalytics

 The operation to be performed on the provided Google Analytics source fields.
 


inforNexus
String inforNexus

 The operation to be performed on the provided Infor Nexus source fields.
 


marketo
String marketo

 The operation to be performed on the provided Marketo source fields.
 


s3
String s3

 The operation to be performed on the provided Amazon S3 source fields.
 


salesforce
String salesforce

 The operation to be performed on the provided Salesforce source fields.
 


serviceNow
String serviceNow

 The operation to be performed on the provided ServiceNow source fields.
 


singular
String singular

 The operation to be performed on the provided Singular source fields.
 


slack
String slack

 The operation to be performed on the provided Slack source fields.
 


trendmicro
String trendmicro

 The operation to be performed on the provided Trend Micro source fields.
 


veeva
String veeva

 The operation to be performed on the provided Veeva source fields.
 


zendesk
String zendesk

 The operation to be performed on the provided Zendesk source fields.
 


sAPOData
String sAPOData

 The operation to be performed on the provided SAPOData source fields.
 


customConnector
String customConnector

 Operators supported by the custom connector.
 


pardot
String pardot

 The operation to be performed on the provided Salesforce Pardot source fields.
 








Class com.amazonaws.services.appflow.model.ConnectorProfile extends Object implements Serializable


Serialized Fields


connectorProfileArn
String connectorProfileArn

 The Amazon Resource Name (ARN) of the connector profile.
 


connectorProfileName
String connectorProfileName

 The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
 Services account.
 


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


connectorLabel
String connectorLabel

 The label for the connector profile being created.
 


connectionMode
String connectionMode

 Indicates the connection mode and if it is public or private.
 


credentialsArn
String credentialsArn

 The Amazon Resource Name (ARN) of the connector profile credentials.
 


connectorProfileProperties
ConnectorProfileProperties connectorProfileProperties

 The connector-specific properties of the profile configuration.
 


createdAt
Date createdAt

 Specifies when the connector profile was created.
 


lastUpdatedAt
Date lastUpdatedAt

 Specifies when the connector profile was last updated.
 


privateConnectionProvisioningState
PrivateConnectionProvisioningState privateConnectionProvisioningState

 Specifies the private connection provisioning state.
 








Class com.amazonaws.services.appflow.model.ConnectorProfileConfig extends Object implements Serializable


Serialized Fields


connectorProfileProperties
ConnectorProfileProperties connectorProfileProperties

 The connector-specific properties of the profile configuration.
 


connectorProfileCredentials
ConnectorProfileCredentials connectorProfileCredentials

 The connector-specific credentials required by each connector.
 








Class com.amazonaws.services.appflow.model.ConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


amplitude
AmplitudeConnectorProfileCredentials amplitude

 The connector-specific credentials required when using Amplitude.
 


datadog
DatadogConnectorProfileCredentials datadog

 The connector-specific credentials required when using Datadog.
 


dynatrace
DynatraceConnectorProfileCredentials dynatrace

 The connector-specific credentials required when using Dynatrace.
 


googleAnalytics
GoogleAnalyticsConnectorProfileCredentials googleAnalytics

 The connector-specific credentials required when using Google Analytics.
 


honeycode
HoneycodeConnectorProfileCredentials honeycode

 The connector-specific credentials required when using Amazon Honeycode.
 


inforNexus
InforNexusConnectorProfileCredentials inforNexus

 The connector-specific credentials required when using Infor Nexus.
 


marketo
MarketoConnectorProfileCredentials marketo

 The connector-specific credentials required when using Marketo.
 


redshift
RedshiftConnectorProfileCredentials redshift

 The connector-specific credentials required when using Amazon Redshift.
 


salesforce
SalesforceConnectorProfileCredentials salesforce

 The connector-specific credentials required when using Salesforce.
 


serviceNow
ServiceNowConnectorProfileCredentials serviceNow

 The connector-specific credentials required when using ServiceNow.
 


singular
SingularConnectorProfileCredentials singular

 The connector-specific credentials required when using Singular.
 


slack
SlackConnectorProfileCredentials slack

 The connector-specific credentials required when using Slack.
 


snowflake
SnowflakeConnectorProfileCredentials snowflake

 The connector-specific credentials required when using Snowflake.
 


trendmicro
TrendmicroConnectorProfileCredentials trendmicro

 The connector-specific credentials required when using Trend Micro.
 


veeva
VeevaConnectorProfileCredentials veeva

 The connector-specific credentials required when using Veeva.
 


zendesk
ZendeskConnectorProfileCredentials zendesk

 The connector-specific credentials required when using Zendesk.
 


sAPOData
SAPODataConnectorProfileCredentials sAPOData


customConnector
CustomConnectorProfileCredentials customConnector


pardot
PardotConnectorProfileCredentials pardot

 The connector-specific credentials required when using Salesforce Pardot.
 








Class com.amazonaws.services.appflow.model.ConnectorProfileProperties extends Object implements Serializable


Serialized Fields


amplitude
AmplitudeConnectorProfileProperties amplitude

 The connector-specific properties required by Amplitude.
 


datadog
DatadogConnectorProfileProperties datadog

 The connector-specific properties required by Datadog.
 


dynatrace
DynatraceConnectorProfileProperties dynatrace

 The connector-specific properties required by Dynatrace.
 


googleAnalytics
GoogleAnalyticsConnectorProfileProperties googleAnalytics

 The connector-specific properties required Google Analytics.
 


honeycode
HoneycodeConnectorProfileProperties honeycode

 The connector-specific properties required by Amazon Honeycode.
 


inforNexus
InforNexusConnectorProfileProperties inforNexus

 The connector-specific properties required by Infor Nexus.
 


marketo
MarketoConnectorProfileProperties marketo

 The connector-specific properties required by Marketo.
 


redshift
RedshiftConnectorProfileProperties redshift

 The connector-specific properties required by Amazon Redshift.
 


salesforce
SalesforceConnectorProfileProperties salesforce

 The connector-specific properties required by Salesforce.
 


serviceNow
ServiceNowConnectorProfileProperties serviceNow

 The connector-specific properties required by serviceNow.
 


singular
SingularConnectorProfileProperties singular

 The connector-specific properties required by Singular.
 


slack
SlackConnectorProfileProperties slack

 The connector-specific properties required by Slack.
 


snowflake
SnowflakeConnectorProfileProperties snowflake

 The connector-specific properties required by Snowflake.
 


trendmicro
TrendmicroConnectorProfileProperties trendmicro

 The connector-specific properties required by Trend Micro.
 


veeva
VeevaConnectorProfileProperties veeva

 The connector-specific properties required by Veeva.
 


zendesk
ZendeskConnectorProfileProperties zendesk

 The connector-specific properties required by Zendesk.
 


sAPOData
SAPODataConnectorProfileProperties sAPOData


customConnector
CustomConnectorProfileProperties customConnector

 The properties required by the custom connector.
 


pardot
PardotConnectorProfileProperties pardot

 The connector-specific properties required by Salesforce Pardot.
 








Class com.amazonaws.services.appflow.model.ConnectorProvisioningConfig extends Object implements Serializable


Serialized Fields


lambda
LambdaConnectorProvisioningConfig lambda

 Contains information about the configuration of the lambda which is being registered as the connector.
 








Class com.amazonaws.services.appflow.model.ConnectorRuntimeSetting extends Object implements Serializable


Serialized Fields


key
String key

 Contains value information about the connector runtime setting.
 


dataType
String dataType

 Data type of the connector runtime setting.
 


isRequired
Boolean isRequired

 Indicates whether this connector runtime setting is required.
 


label
String label

 A label used for connector runtime setting.
 


description
String description

 A description about the connector runtime setting.
 


scope
String scope

 Indicates the scope of the connector runtime setting.
 


connectorSuppliedValueOptions
List<E> connectorSuppliedValueOptions

 Contains default values for the connector runtime setting that are supplied by the connector.
 








Class com.amazonaws.services.appflow.model.ConnectorServerException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.CreateConnectorProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileName
String connectorProfileName

 The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
 Services account.
 


kmsArn
String kmsArn

 The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
 required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
 AppFlow uses the Amazon AppFlow-managed KMS key.
 


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


connectorLabel
String connectorLabel

 The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
 Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
 


connectionMode
String connectionMode

 Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
 Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
 internet.
 


connectorProfileConfig
ConnectorProfileConfig connectorProfileConfig

 Defines the connector-specific configuration and credentials.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your
 CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
 you don't receive a response from your request, you can safely retry the request with the same
 clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
 . The token is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.CreateConnectorProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorProfileArn
String connectorProfileArn

 The Amazon Resource Name (ARN) of the connector profile.
 








Class com.amazonaws.services.appflow.model.CreateFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


description
String description

 A description of the flow you want to create.
 


kmsArn
String kmsArn

 The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
 required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
 AppFlow uses the Amazon AppFlow-managed KMS key.
 


triggerConfig
TriggerConfig triggerConfig

 The trigger settings that determine how and when the flow runs.
 


sourceFlowConfig
SourceFlowConfig sourceFlowConfig

 The configuration that controls how Amazon AppFlow retrieves data from the source connector.
 


destinationFlowConfigList
List<E> destinationFlowConfigList

 The configuration that controls how Amazon AppFlow places data in the destination connector.
 


tasks
List<E> tasks

 A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for your flow.
 


metadataCatalogConfig
MetadataCatalogConfig metadataCatalogConfig

 Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
 associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your CreateFlow
 request completes only once. You choose the value to pass. For example, if you don't receive a response from your
 request, you can safely retry the request with the same clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token
 is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.CreateFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn

 The flow's Amazon Resource Name (ARN).
 


flowStatus
String flowStatus

 Indicates the current status of the flow.
 








Class com.amazonaws.services.appflow.model.CustomAuthConfig extends Object implements Serializable


Serialized Fields


customAuthenticationType
String customAuthenticationType

 The authentication type that the custom connector uses.
 


authParameters
List<E> authParameters

 Information about authentication parameters required for authentication.
 








Class com.amazonaws.services.appflow.model.CustomAuthCredentials extends Object implements Serializable


Serialized Fields


customAuthenticationType
String customAuthenticationType

 The custom authentication type that the connector uses.
 


credentialsMap
Map<K,V> credentialsMap

 A map that holds custom authentication credentials.
 








Class com.amazonaws.services.appflow.model.CustomConnectorDestinationProperties extends Object implements Serializable


Serialized Fields


entityName
String entityName

 The entity specified in the custom connector as a destination in the flow.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig

 The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as
 destination.
 


writeOperationType
String writeOperationType

 Specifies the type of write operation to be performed in the custom connector when it's used as destination.
 


idFieldNames
List<E> idFieldNames

 The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
 or upsert.
 


customProperties
Map<K,V> customProperties

 The custom properties that are specific to the connector when it's used as a destination in the flow.
 








Class com.amazonaws.services.appflow.model.CustomConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


authenticationType
String authenticationType

 The authentication type that the custom connector uses for authenticating while creating a connector profile.
 


basic
BasicAuthCredentials basic

 The basic credentials that are required for the authentication of the user.
 


oauth2
OAuth2Credentials oauth2

 The OAuth 2.0 credentials required for the authentication of the user.
 


apiKey
ApiKeyCredentials apiKey

 The API keys required for the authentication of the user.
 


custom
CustomAuthCredentials custom

 If the connector uses the custom authentication mechanism, this holds the required credentials.
 








Class com.amazonaws.services.appflow.model.CustomConnectorProfileProperties extends Object implements Serializable


Serialized Fields


profileProperties
Map<K,V> profileProperties

 A map of properties that are required to create a profile for the custom connector.
 


oAuth2Properties
OAuth2Properties oAuth2Properties








Class com.amazonaws.services.appflow.model.CustomConnectorSourceProperties extends Object implements Serializable


Serialized Fields


entityName
String entityName

 The entity specified in the custom connector as a source in the flow.
 


customProperties
Map<K,V> customProperties

 Custom properties that are required to use the custom connector as a source.
 


dataTransferApi
DataTransferApi dataTransferApi

 The API of the connector application that Amazon AppFlow uses to transfer your data.
 








Class com.amazonaws.services.appflow.model.CustomerProfilesDestinationProperties extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The unique name of the Amazon Connect Customer Profiles domain.
 


objectTypeName
String objectTypeName

 The object specified in the Amazon Connect Customer Profiles flow destination.
 








Class com.amazonaws.services.appflow.model.CustomerProfilesMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.DatadogConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


apiKey
String apiKey

 A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
 


applicationKey
String applicationKey

 Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API.
 Application keys are associated with the user account that created them. The application key is used to log all
 requests made to the API.
 








Class com.amazonaws.services.appflow.model.DatadogConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Datadog resource.
 








Class com.amazonaws.services.appflow.model.DatadogMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.DatadogSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Datadog flow source.
 








Class com.amazonaws.services.appflow.model.DataTransferApi extends Object implements Serializable


Serialized Fields


name
String name

 The name of the connector application API.
 


type
String type

 You can specify one of the following types:
 
 
 AUTOMATIC
 
 
 The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon
 AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.
 
 
 SYNC
 
 
 A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
 
 
 ASYNC
 
 
 An asynchronous API. This type of API optimizes a flow for large datasets.
 
 
 








Class com.amazonaws.services.appflow.model.DeleteConnectorProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileName
String connectorProfileName

 The name of the connector profile. The name is unique for each ConnectorProfile in your account.
 


forceDelete
Boolean forceDelete

 Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
 








Class com.amazonaws.services.appflow.model.DeleteConnectorProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appflow.model.DeleteFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


forceDelete
Boolean forceDelete

 Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
 








Class com.amazonaws.services.appflow.model.DeleteFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appflow.model.DescribeConnectorEntityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorEntityName
String connectorEntityName

 The entity name for that connector.
 


connectorType
String connectorType

 The type of connector application, such as Salesforce, Amplitude, and so on.
 


connectorProfileName
String connectorProfileName

 The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
 Services account.
 


apiVersion
String apiVersion

 The version of the API that's used by the connector.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorEntityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorEntityFields
List<E> connectorEntityFields

 Describes the fields for that connector entity. For example, for an account entity, the fields would be
 account name, account ID, and so on.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileNames
List<E> connectorProfileNames

 The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
 Services account.
 


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


connectorLabel
String connectorLabel

 The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web
 Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
 


maxResults
Integer maxResults

 Specifies the maximum number of items that should be returned in the result set. The default for
 maxResults is 20 (for all paginated API operations).
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorProfileDetails
List<E> connectorProfileDetails

 Returns information about the connector profiles associated with the flow.
 


nextToken
String nextToken

 The pagination token for the next page of data. If nextToken=null, this means that all records have
 been fetched.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorType
String connectorType

 The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based
 custom connectors.
 


connectorLabel
String connectorLabel

 The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
 Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorConfiguration
ConnectorConfiguration connectorConfiguration

 Configuration info of all the connectors that the user requested.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorTypes
List<E> connectorTypes

 The type of connector, such as Salesforce, Amplitude, and so on.
 


maxResults
Integer maxResults

 The maximum number of items that should be returned in the result set. The default is 20.
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.DescribeConnectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorConfigurations
Map<K,V> connectorConfigurations

 The configuration that is applied to the connectors used in the flow.
 


connectors
List<E> connectors

 Information about the connectors supported in Amazon AppFlow.
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.DescribeFlowExecutionRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


maxResults
Integer maxResults

 Specifies the maximum number of items that should be returned in the result set. The default for
 maxResults is 20 (for all paginated API operations).
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.DescribeFlowExecutionRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowExecutions
List<E> flowExecutions

 Returns a list of all instances when this flow was run.
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.DescribeFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 








Class com.amazonaws.services.appflow.model.DescribeFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn

 The flow's Amazon Resource Name (ARN).
 


description
String description

 A description of the flow.
 


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


kmsArn
String kmsArn

 The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
 required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
 AppFlow uses the Amazon AppFlow-managed KMS key.
 


flowStatus
String flowStatus

 Indicates the current status of the flow.
 


flowStatusMessage
String flowStatusMessage

 Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or
 event-triggered flows.
 


sourceFlowConfig
SourceFlowConfig sourceFlowConfig

 The configuration that controls how Amazon AppFlow retrieves data from the source connector.
 


destinationFlowConfigList
List<E> destinationFlowConfigList

 The configuration that controls how Amazon AppFlow transfers data to the destination connector.
 


lastRunExecutionDetails
ExecutionDetails lastRunExecutionDetails

 Describes the details of the most recent flow run.
 


triggerConfig
TriggerConfig triggerConfig

 The trigger settings that determine how and when the flow runs.
 


tasks
List<E> tasks

 A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
 


createdAt
Date createdAt

 Specifies when the flow was created.
 


lastUpdatedAt
Date lastUpdatedAt

 Specifies when the flow was last updated.
 


createdBy
String createdBy

 The ARN of the user who created the flow.
 


lastUpdatedBy
String lastUpdatedBy

 Specifies the user name of the account that performed the most recent update.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for your flow.
 


metadataCatalogConfig
MetadataCatalogConfig metadataCatalogConfig

 Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
 associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
 


lastRunMetadataCatalogDetails
List<E> lastRunMetadataCatalogDetails

 Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
 flow run.
 


schemaVersion
Long schemaVersion

 The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases
 by one when you change any of the following settings in your flow configuration:
 
 
 
 
 Source-to-destination field mappings
 
 
 
 
 Field data types
 
 
 
 
 Partition keys
 
 
 








Class com.amazonaws.services.appflow.model.DestinationConnectorProperties extends Object implements Serializable


Serialized Fields


redshift
RedshiftDestinationProperties redshift

 The properties required to query Amazon Redshift.
 


s3
S3DestinationProperties s3

 The properties required to query Amazon S3.
 


salesforce
SalesforceDestinationProperties salesforce

 The properties required to query Salesforce.
 


snowflake
SnowflakeDestinationProperties snowflake

 The properties required to query Snowflake.
 


eventBridge
EventBridgeDestinationProperties eventBridge

 The properties required to query Amazon EventBridge.
 


lookoutMetrics
LookoutMetricsDestinationProperties lookoutMetrics

 The properties required to query Amazon Lookout for Metrics.
 


upsolver
UpsolverDestinationProperties upsolver

 The properties required to query Upsolver.
 


honeycode
HoneycodeDestinationProperties honeycode

 The properties required to query Amazon Honeycode.
 


customerProfiles
CustomerProfilesDestinationProperties customerProfiles

 The properties required to query Amazon Connect Customer Profiles.
 


zendesk
ZendeskDestinationProperties zendesk

 The properties required to query Zendesk.
 


marketo
MarketoDestinationProperties marketo

 The properties required to query Marketo.
 


customConnector
CustomConnectorDestinationProperties customConnector

 The properties that are required to query the custom Connector.
 


sAPOData
SAPODataDestinationProperties sAPOData

 The properties required to query SAPOData.
 








Class com.amazonaws.services.appflow.model.DestinationFieldProperties extends Object implements Serializable


Serialized Fields


isCreatable
Boolean isCreatable

 Specifies if the destination field can be created by the current user.
 


isNullable
Boolean isNullable

 Specifies if the destination field can have a null value.
 


isUpsertable
Boolean isUpsertable

 Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or
 update them if they do.
 


isUpdatable
Boolean isUpdatable

 Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
 


isDefaultedOnCreate
Boolean isDefaultedOnCreate

 Specifies whether the field can use the default value during a Create operation.
 


supportedWriteOperations
List<E> supportedWriteOperations

 A list of supported write operations. For each write operation listed, this field can be used in
 idFieldNames when that write operation is present as a destination option.
 








Class com.amazonaws.services.appflow.model.DestinationFlowConfig extends Object implements Serializable


Serialized Fields


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


apiVersion
String apiVersion

 The API version that the destination connector uses.
 


connectorProfileName
String connectorProfileName

 The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services
 account.
 


destinationConnectorProperties
DestinationConnectorProperties destinationConnectorProperties

 This stores the information that is required to query a particular connector.
 








Class com.amazonaws.services.appflow.model.DynatraceConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


apiToken
String apiToken

 The API tokens used by Dynatrace API to authenticate various API calls.
 








Class com.amazonaws.services.appflow.model.DynatraceConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Dynatrace resource.
 








Class com.amazonaws.services.appflow.model.DynatraceMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.DynatraceSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Dynatrace flow source.
 








Class com.amazonaws.services.appflow.model.ErrorHandlingConfig extends Object implements Serializable


Serialized Fields


failOnFirstDestinationError
Boolean failOnFirstDestinationError

 Specifies if the flow should fail after the first instance of a failure when attempting to place data in the
 destination.
 


bucketPrefix
String bucketPrefix

 Specifies the Amazon S3 bucket prefix.
 


bucketName
String bucketName

 Specifies the name of the Amazon S3 bucket.
 








Class com.amazonaws.services.appflow.model.ErrorInfo extends Object implements Serializable


Serialized Fields


putFailuresCount
Long putFailuresCount

 Specifies the failure count for the attempted flow.
 


executionMessage
String executionMessage

 Specifies the error message that appears if a flow fails.
 








Class com.amazonaws.services.appflow.model.EventBridgeDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Amazon EventBridge flow destination.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig








Class com.amazonaws.services.appflow.model.EventBridgeMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.ExecutionDetails extends Object implements Serializable


Serialized Fields


mostRecentExecutionMessage
String mostRecentExecutionMessage

 Describes the details of the most recent flow run.
 


mostRecentExecutionTime
Date mostRecentExecutionTime

 Specifies the time of the most recent flow run.
 


mostRecentExecutionStatus
String mostRecentExecutionStatus

 Specifies the status of the most recent flow run.
 








Class com.amazonaws.services.appflow.model.ExecutionRecord extends Object implements Serializable


Serialized Fields


executionId
String executionId

 Specifies the identifier of the given flow run.
 


executionStatus
String executionStatus

 Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
 


executionResult
ExecutionResult executionResult

 Describes the result of the given flow run.
 


startedAt
Date startedAt

 Specifies the start time of the flow run.
 


lastUpdatedAt
Date lastUpdatedAt

 Specifies the time of the most recent update.
 


dataPullStartTime
Date dataPullStartTime

 The timestamp that determines the first new or updated record to be transferred in the flow run.
 


dataPullEndTime
Date dataPullEndTime

 The timestamp that indicates the last new or updated record to be transferred in the flow run.
 


metadataCatalogDetails
List<E> metadataCatalogDetails

 Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated
 flow run.
 








Class com.amazonaws.services.appflow.model.ExecutionResult extends Object implements Serializable


Serialized Fields


errorInfo
ErrorInfo errorInfo

 Provides any error message information related to the flow run.
 


bytesProcessed
Long bytesProcessed

 The total number of bytes processed by the flow run.
 


bytesWritten
Long bytesWritten

 The total number of bytes written as a result of the flow run.
 


recordsProcessed
Long recordsProcessed

 The number of records processed in the flow run.
 


numParallelProcesses
Long numParallelProcesses

 The number of processes that Amazon AppFlow ran at the same time when it retrieved your data.
 


maxPageSize
Long maxPageSize

 The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP
 application.
 








Class com.amazonaws.services.appflow.model.FieldTypeDetails extends Object implements Serializable


Serialized Fields


fieldType
String fieldType

 The type of field, such as string, integer, date, and so on.
 


filterOperators
List<E> filterOperators

 The list of operators supported by a field.
 


supportedValues
List<E> supportedValues

 The list of values that a field can contain. For example, a Boolean fieldType can have two values:
 "true" and "false".
 


valueRegexPattern
String valueRegexPattern

 The regular expression pattern for the field name.
 


supportedDateFormat
String supportedDateFormat

 The date format that the field supports.
 


fieldValueRange
Range fieldValueRange

 The range of values this field can hold.
 


fieldLengthRange
Range fieldLengthRange

 This is the allowable length range for this field's value.
 








Class com.amazonaws.services.appflow.model.FlowDefinition extends Object implements Serializable


Serialized Fields


flowArn
String flowArn

 The flow's Amazon Resource Name (ARN).
 


description
String description

 A user-entered description of the flow.
 


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


flowStatus
String flowStatus

 Indicates the current status of the flow.
 


sourceConnectorType
String sourceConnectorType

 Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
 


sourceConnectorLabel
String sourceConnectorLabel

 The label of the source connector in the flow.
 


destinationConnectorType
String destinationConnectorType

 Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
 


destinationConnectorLabel
String destinationConnectorLabel

 The label of the destination connector in the flow.
 


triggerType
String triggerType

 Specifies the type of flow trigger. This can be OnDemand, Scheduled, or
 Event.
 


createdAt
Date createdAt

 Specifies when the flow was created.
 


lastUpdatedAt
Date lastUpdatedAt

 Specifies when the flow was last updated.
 


createdBy
String createdBy

 The ARN of the user who created the flow.
 


lastUpdatedBy
String lastUpdatedBy

 Specifies the account user name that most recently updated the flow.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for your flow.
 


lastRunExecutionDetails
ExecutionDetails lastRunExecutionDetails

 Describes the details of the most recent flow run.
 








Class com.amazonaws.services.appflow.model.GlueDataCatalogConfig extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data
 Catalog tables, databases, and partitions.
 
 
 For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
 


databaseName
String databaseName

 The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon
 Web Services account. These tables contain metadata for the data that's transferred by the flow that you
 configure with this parameter.
 
 
 
 When you configure a new flow with this parameter, you must specify an existing database.
 
 


tablePrefix
String tablePrefix

 A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this
 setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
 








Class com.amazonaws.services.appflow.model.GoogleAnalyticsConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the desired client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The credentials used to access protected Google Analytics resources.
 


refreshToken
String refreshToken

 The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not
 required for OAuth1 access tokens.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 








Class com.amazonaws.services.appflow.model.GoogleAnalyticsConnectorProfileProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.GoogleAnalyticsMetadata extends Object implements Serializable


Serialized Fields


oAuthScopes
List<E> oAuthScopes

 The desired authorization scope for the Google Analytics account.
 








Class com.amazonaws.services.appflow.model.GoogleAnalyticsSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Google Analytics flow source.
 








Class com.amazonaws.services.appflow.model.HoneycodeConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


accessToken
String accessToken

 The credentials used to access protected Amazon Honeycode resources.
 


refreshToken
String refreshToken

 The credentials used to acquire new access tokens.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest








Class com.amazonaws.services.appflow.model.HoneycodeConnectorProfileProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.HoneycodeDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Amazon Honeycode flow destination.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig








Class com.amazonaws.services.appflow.model.HoneycodeMetadata extends Object implements Serializable


Serialized Fields


oAuthScopes
List<E> oAuthScopes

 The desired authorization scope for the Amazon Honeycode account.
 








Class com.amazonaws.services.appflow.model.IncrementalPullConfig extends Object implements Serializable


Serialized Fields


datetimeTypeFieldName
String datetimeTypeFieldName

 A field that specifies the date time or timestamp field as the criteria to use when importing incremental records
 from the source.
 








Class com.amazonaws.services.appflow.model.InforNexusConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 The Access Key portion of the credentials.
 


userId
String userId

 The identifier for the user.
 


secretAccessKey
String secretAccessKey

 The secret key used to sign requests.
 


datakey
String datakey

 The encryption keys used to encrypt data.
 








Class com.amazonaws.services.appflow.model.InforNexusConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Infor Nexus resource.
 








Class com.amazonaws.services.appflow.model.InforNexusMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.InforNexusSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Infor Nexus flow source.
 








Class com.amazonaws.services.appflow.model.InternalServerException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.LambdaConnectorProvisioningConfig extends Object implements Serializable


Serialized Fields


lambdaArn
String lambdaArn

 Lambda ARN of the connector being registered.
 








Class com.amazonaws.services.appflow.model.ListConnectorEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileName
String connectorProfileName

 The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web
 Services account, and is used to query the downstream connector.
 


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


entitiesPath
String entitiesPath

 This optional parameter is specific to connector implementation. Some connectors support multiple levels or
 categories of entities. You can find out the list of roots for such providers by sending a request without the
 entitiesPath parameter. If the connector supports entities at different roots, this initial request
 returns the list of roots. Otherwise, this request returns all entities supported by the provider.
 


apiVersion
String apiVersion

 The version of the API that's used by the connector.
 


maxResults
Integer maxResults

 The maximum number of items that the operation returns in the response.
 


nextToken
String nextToken

 A token that was provided by your prior ListConnectorEntities operation if the response was too big
 for the page size. You specify this token to get the next page of results in paginated response.
 








Class com.amazonaws.services.appflow.model.ListConnectorEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorEntityMap
Map<K,V> connectorEntityMap

 The response of ListConnectorEntities lists entities grouped by category. This map's key represents
 the group name, and its value contains the list of entities belonging to that group.
 


nextToken
String nextToken

 A token that you specify in your next ListConnectorEntities operation to get the next page of
 results in paginated response. The ListConnectorEntities operation provides this token if the
 response is too big for the page size.
 








Class com.amazonaws.services.appflow.model.ListConnectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Specifies the maximum number of items that should be returned in the result set. The default for
 maxResults is 20 (for all paginated API operations).
 


nextToken
String nextToken

 The pagination token for the next page of data.
 








Class com.amazonaws.services.appflow.model.ListConnectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectors
List<E> connectors

 Contains information about the connectors supported by Amazon AppFlow.
 


nextToken
String nextToken

 The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
 








Class com.amazonaws.services.appflow.model.ListFlowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Specifies the maximum number of items that should be returned in the result set.
 


nextToken
String nextToken

 The pagination token for next page of data.
 








Class com.amazonaws.services.appflow.model.ListFlowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flows
List<E> flows

 The list of flows associated with your account.
 


nextToken
String nextToken

 The pagination token for next page of data.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the specified flow.
 








Class com.amazonaws.services.appflow.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags used to organize, track, or control access for your flow.
 








Class com.amazonaws.services.appflow.model.LookoutMetricsDestinationProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.MarketoConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the desired client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The credentials used to access protected Marketo resources.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 








Class com.amazonaws.services.appflow.model.MarketoConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Marketo resource.
 








Class com.amazonaws.services.appflow.model.MarketoDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Marketo flow destination.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig








Class com.amazonaws.services.appflow.model.MarketoMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.MarketoSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Marketo flow source.
 








Class com.amazonaws.services.appflow.model.MetadataCatalogConfig extends Object implements Serializable


Serialized Fields


glueDataCatalog
GlueDataCatalogConfig glueDataCatalog

 Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.
 








Class com.amazonaws.services.appflow.model.MetadataCatalogDetail extends Object implements Serializable


Serialized Fields


catalogType
String catalogType

 The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the
 following value:
 
 
 GLUE
 
 
 The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.
 
 
 


tableName
String tableName

 The name of the table that stores the metadata for the associated flow run. The table stores metadata that
 represents the data that the flow transferred. Amazon AppFlow stores the table in the metadata catalog.
 


tableRegistrationOutput
RegistrationOutput tableRegistrationOutput

 Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog.
 Amazon AppFlow creates or updates this table for the associated flow run.
 


partitionRegistrationOutput
RegistrationOutput partitionRegistrationOutput

 Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata
 catalog. The data partitions organize the flow output into a hierarchical path, such as a folder path in an S3
 bucket. Amazon AppFlow creates the partitions (if they don't already exist) based on your flow configuration.
 








Class com.amazonaws.services.appflow.model.OAuth2Credentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the desired client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The access token used to access the connector on your behalf.
 


refreshToken
String refreshToken

 The refresh token used to refresh an expired access token.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest








Class com.amazonaws.services.appflow.model.OAuth2CustomParameter extends Object implements Serializable


Serialized Fields


key
String key

 The key of the custom parameter required for OAuth 2.0 authentication.
 


isRequired
Boolean isRequired

 Indicates whether the custom parameter for OAuth 2.0 authentication is required.
 


label
String label

 The label of the custom parameter used for OAuth 2.0 authentication.
 


description
String description

 A description about the custom parameter used for OAuth 2.0 authentication.
 


isSensitiveField
Boolean isSensitiveField

 Indicates whether this authentication custom parameter is a sensitive field.
 


connectorSuppliedValues
List<E> connectorSuppliedValues

 Contains default values for this authentication parameter that are supplied by the connector.
 


type
String type

 Indicates whether custom parameter is used with TokenUrl or AuthUrl.
 








Class com.amazonaws.services.appflow.model.OAuth2Defaults extends Object implements Serializable


Serialized Fields


oauthScopes
List<E> oauthScopes

 OAuth 2.0 scopes that the connector supports.
 


tokenUrls
List<E> tokenUrls

 Token URLs that can be used for OAuth 2.0 authentication.
 


authCodeUrls
List<E> authCodeUrls

 Auth code URLs that can be used for OAuth 2.0 authentication.
 


oauth2GrantTypesSupported
List<E> oauth2GrantTypesSupported

 OAuth 2.0 grant types supported by the connector.
 


oauth2CustomProperties
List<E> oauth2CustomProperties

 List of custom parameters required for OAuth 2.0 authentication.
 








Class com.amazonaws.services.appflow.model.OAuth2Properties extends Object implements Serializable


Serialized Fields


tokenUrl
String tokenUrl

 The token URL required for OAuth 2.0 authentication.
 


oAuth2GrantType
String oAuth2GrantType

 The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
 


tokenUrlCustomProperties
Map<K,V> tokenUrlCustomProperties

 Associates your token URL with a map of properties that you define. Use this parameter to provide any additional
 details that the connector requires to authenticate your request.
 








Class com.amazonaws.services.appflow.model.OAuthCredentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the desired client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The access token used to access protected SAPOData resources.
 


refreshToken
String refreshToken

 The refresh token used to refresh expired access token.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 








Class com.amazonaws.services.appflow.model.OAuthProperties extends Object implements Serializable


Serialized Fields


tokenUrl
String tokenUrl

 The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access
 token using refresh token.
 


authCodeUrl
String authCodeUrl

 The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type
 authentication.
 


oAuthScopes
List<E> oAuthScopes

 The OAuth scopes required for OAuth type authentication.
 








Class com.amazonaws.services.appflow.model.PardotConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


accessToken
String accessToken

 The credentials used to access protected Salesforce Pardot resources.
 


refreshToken
String refreshToken

 The credentials used to acquire new access tokens.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest


clientCredentialsArn
String clientCredentialsArn

 The secret manager ARN, which contains the client ID and client secret of the connected app.
 








Class com.amazonaws.services.appflow.model.PardotConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Salesforce Pardot resource.
 


isSandboxEnvironment
Boolean isSandboxEnvironment

 Indicates whether the connector profile applies to a sandbox or production environment.
 


businessUnitId
String businessUnitId

 The business unit id of Salesforce Pardot instance.
 








Class com.amazonaws.services.appflow.model.PardotMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.PardotSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Salesforce Pardot flow source.
 








Class com.amazonaws.services.appflow.model.PrefixConfig extends Object implements Serializable


Serialized Fields


prefixType
String prefixType

 Determines the format of the prefix, and whether it applies to the file name, file path, or both.
 


prefixFormat
String prefixFormat

 Determines the level of granularity for the date and time that's included in the prefix.
 


pathPrefixHierarchy
List<E> pathPrefixHierarchy

 Specifies whether the destination file path includes either or both of the following elements:
 
 
 EXECUTION_ID
 
 
 The ID that Amazon AppFlow assigns to the flow run.
 
 
 SCHEMA_VERSION
 
 
 The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases
 by one when you change any of the following settings in your flow configuration:
 
 
 
 
 Source-to-destination field mappings
 
 
 
 
 Field data types
 
 
 
 
 Partition keys
 
 
 
 
 








Class com.amazonaws.services.appflow.model.PrivateConnectionProvisioningState extends Object implements Serializable


Serialized Fields


status
String status

 Specifies the private connection provisioning status.
 


failureMessage
String failureMessage

 Specifies the private connection provisioning failure reason.
 


failureCause
String failureCause

 Specifies the private connection provisioning failure cause.
 








Class com.amazonaws.services.appflow.model.Range extends Object implements Serializable


Serialized Fields


maximum
Double maximum

 Maximum value supported by the field.
 


minimum
Double minimum

 Minimum value supported by the field.
 








Class com.amazonaws.services.appflow.model.RedshiftConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


username
String username

 The name of the user.
 


password
String password

 The password that corresponds to the user name.
 








Class com.amazonaws.services.appflow.model.RedshiftConnectorProfileProperties extends Object implements Serializable


Serialized Fields


databaseUrl
String databaseUrl

 The JDBC URL of the Amazon Redshift cluster.
 


bucketName
String bucketName

 A name for the associated Amazon S3 bucket.
 


bucketPrefix
String bucketPrefix

 The object key for the destination bucket in which Amazon AppFlow places the files.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more
 information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.
 


dataApiRoleArn
String dataApiRoleArn

 The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database
 through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.
 


isRedshiftServerless
Boolean isRedshiftServerless

 Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
 


clusterIdentifier
String clusterIdentifier

 The unique ID that's assigned to an Amazon Redshift cluster.
 


workgroupName
String workgroupName

 The name of an Amazon Redshift workgroup.
 


databaseName
String databaseName

 The name of an Amazon Redshift database.
 








Class com.amazonaws.services.appflow.model.RedshiftDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Amazon Redshift flow destination.
 


intermediateBucketName
String intermediateBucketName

 The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
 


bucketPrefix
String bucketPrefix

 The object key for the bucket in which Amazon AppFlow places the destination files.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig

 The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift
 destination. For example, this setting would determine if the flow should fail after one insertion error, or
 continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig
 is a part of the destination connector details.
 








Class com.amazonaws.services.appflow.model.RedshiftMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.RegisterConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorLabel
String connectorLabel

 The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web
 Services account.
 


description
String description

 A description about the connector that's being registered.
 


connectorProvisioningType
String connectorProvisioningType

 The provisioning type of the connector. Currently the only supported value is LAMBDA.
 


connectorProvisioningConfig
ConnectorProvisioningConfig connectorProvisioningConfig

 The provisioning type of the connector. Currently the only supported value is LAMBDA.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your
 RegisterConnector request completes only once. You choose the value to pass. For example, if you
 don't receive a response from your request, you can safely retry the request with the same
 clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The
 token is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.RegisterConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorArn
String connectorArn

 The ARN of the connector being registered.
 








Class com.amazonaws.services.appflow.model.RegistrationOutput extends Object implements Serializable


Serialized Fields


message
String message

 Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains
 why.
 


result
String result

 Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata
 tables and data partitions.
 


status
String status

 Indicates the status of the registration attempt from Amazon AppFlow.
 








Class com.amazonaws.services.appflow.model.ResetConnectorMetadataCacheRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileName
String connectorProfileName

 The name of the connector profile that you want to reset cached metadata for.
 
 
 You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect,
 Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any
 other connector, you must include this parameter in your request.
 


connectorType
String connectorType

 The type of connector to reset cached metadata for.
 
 
 You must include this parameter in your request if you're resetting the cache for any of the following
 connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're
 resetting the cache for any other connector, you can omit this parameter from your request.
 


connectorEntityName
String connectorEntityName

 Use this parameter if you want to reset cached metadata about the details for an individual entity.
 
 
 If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity
 names, not entity details.
 


entitiesPath
String entitiesPath

 Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors
 support nested entities. A nested entity is one that has another entity as a parent. To use this parameter,
 specify the name of the parent entity.
 
 
 To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the
 entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates
 whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a
 parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for
 that parent.
 


apiVersion
String apiVersion

 The API version that you specified in the connector profile that you’re resetting cached metadata for. You must
 use this parameter only if the connector supports multiple API versions or if the connector type is
 CustomConnector.
 
 
 To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the
 value that Amazon AppFlow returns for the connectorVersion parameter.
 
 
 To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that
 Amazon AppFlow returns for the connectorType parameter.
 
 
 To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.
 








Class com.amazonaws.services.appflow.model.ResetConnectorMetadataCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appflow.model.ResourceNotFoundException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.S3DestinationProperties extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
 


bucketPrefix
String bucketPrefix

 The object key for the destination bucket in which Amazon AppFlow places the files.
 


s3OutputFormatConfig
S3OutputFormatConfig s3OutputFormatConfig








Class com.amazonaws.services.appflow.model.S3InputFormatConfig extends Object implements Serializable


Serialized Fields


s3InputFileType
String s3InputFileType

 The file type that Amazon AppFlow gets from your Amazon S3 bucket.
 








Class com.amazonaws.services.appflow.model.S3Metadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.S3OutputFormatConfig extends Object implements Serializable


Serialized Fields


fileType
String fileType

 Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
 


prefixConfig
PrefixConfig prefixConfig

 Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name
 folders according to the flow frequency and date.
 


aggregationConfig
AggregationConfig aggregationConfig


preserveSourceDataTyping
Boolean preserveSourceDataTyping

 If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types
 in your source data when it writes the output to Amazon S3.
 
 
 
 
 true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer
 or 1 in your source data is still an integer in your output.
 
 
 
 
 false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For
 example, an integer of 1 in your source data becomes the string "1" in the output.
 
 
 








Class com.amazonaws.services.appflow.model.S3SourceProperties extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The Amazon S3 bucket name where the source files are stored.
 


bucketPrefix
String bucketPrefix

 The object key for the Amazon S3 bucket in which the source files are stored.
 


s3InputFormatConfig
S3InputFormatConfig s3InputFormatConfig








Class com.amazonaws.services.appflow.model.SalesforceConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


accessToken
String accessToken

 The credentials used to access protected Salesforce resources.
 


refreshToken
String refreshToken

 The credentials used to acquire new access tokens.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 


clientCredentialsArn
String clientCredentialsArn

 The secret manager ARN, which contains the client ID and client secret of the connected app.
 


oAuth2GrantType
String oAuth2GrantType

 Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.
 Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
 
 
 You can specify one of the following values:
 
 
 AUTHORIZATION_CODE
 
 
 Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow
 receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon
 AppFlow to access your records.
 
 
 CLIENT_CREDENTIALS
 
 
 Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from
 Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce
 account.
 
 
 JWT_BEARER
 
 
 Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the
 JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type,
 you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
 
 
 


jwtToken
String jwtToken

 A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
 








Class com.amazonaws.services.appflow.model.SalesforceConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Salesforce resource.
 


isSandboxEnvironment
Boolean isSandboxEnvironment

 Indicates whether the connector profile applies to a sandbox or production environment.
 


usePrivateLinkForMetadataAndAuthorization
Boolean usePrivateLinkForMetadataAndAuthorization

 If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the
 private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls
 through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without
 being exposed to the public internet.
 
 
 Set either of the following values:
 
 
 true
 
 
 Amazon AppFlow sends all calls to Salesforce over the private network.
 
 
 These private calls are:
 
 
 
 
 Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their
 fields.
 
 
 
 
 Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
 
 
 
 
 Calls to transfer your Salesforce records as part of a flow run.
 
 
 
 
 false
 
 
 The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public
 internet.
 
 
 The public calls are:
 
 
 
 
 Calls to get metadata about your Salesforce records.
 
 
 
 
 Calls to get or refresh access tokens.
 
 
 
 
 The private calls are:
 
 
 
 
 Calls to transfer your Salesforce records as part of a flow run.
 
 
 
 
 








Class com.amazonaws.services.appflow.model.SalesforceDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Salesforce flow destination.
 


idFieldNames
List<E> idFieldNames

 The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or
 delete.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig

 The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
 For example, this setting would determine if the flow should fail after one insertion error, or continue and
 attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of
 the destination connector details.
 


writeOperationType
String writeOperationType

 This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT,
 then idFieldNames is required.
 


dataTransferApi
String dataTransferApi

 Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
 
 
 AUTOMATIC
 
 
 The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to
 Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your
 flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
 
 
 Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be
 aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow
 runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next
 day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data
 differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk
 API 2.0 doesn't transfer Salesforce compound fields.
 
 
 By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff
 is inconsistent formatting in the output.
 
 
 BULKV2
 
 
 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for
 large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize
 performance only for large data transfers.
 
 
 Note that Bulk API 2.0 does not transfer Salesforce compound fields.
 
 
 REST_SYNC
 
 
 Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes
 consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0.
 In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.
 
 
 








Class com.amazonaws.services.appflow.model.SalesforceMetadata extends Object implements Serializable


Serialized Fields


oAuthScopes
List<E> oAuthScopes

 The desired authorization scope for the Salesforce account.
 


dataTransferApis
List<E> dataTransferApis

 The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
 


oauth2GrantTypesSupported
List<E> oauth2GrantTypesSupported

 The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon
 AppFlow requires an access token each time it attempts to access your Salesforce records.
 
 
 AUTHORIZATION_CODE
 
 
 Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow
 receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon
 AppFlow to access your records.
 
 
 CLIENT_CREDENTIALS
 
 
 Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from
 Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce
 account.
 
 
 JWT_BEARER
 
 
 Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the
 JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type,
 you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
 
 
 








Class com.amazonaws.services.appflow.model.SalesforceSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Salesforce flow source.
 


enableDynamicFieldUpdate
Boolean enableDynamicFieldUpdate

 The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a
 flow.
 


includeDeletedRecords
Boolean includeDeletedRecords

 Indicates whether Amazon AppFlow includes deleted files in the flow run.
 


dataTransferApi
String dataTransferApi

 Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
 
 
 AUTOMATIC
 
 
 The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from
 Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your
 flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
 
 
 Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be
 aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow
 runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the
 next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the
 data differently. Some of the differences include how dates are formatted and null values are represented. Also,
 Bulk API 2.0 doesn't transfer Salesforce compound fields.
 
 
 By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff
 is inconsistent formatting in the output.
 
 
 BULKV2
 
 
 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for
 large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize
 performance only for large data transfers.
 
 
 Note that Bulk API 2.0 does not transfer Salesforce compound fields.
 
 
 REST_SYNC
 
 
 Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes
 consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0.
 In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
 
 
 








Class com.amazonaws.services.appflow.model.SAPODataConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


basicAuthCredentials
BasicAuthCredentials basicAuthCredentials

 The SAPOData basic authentication credentials.
 


oAuthCredentials
OAuthCredentials oAuthCredentials

 The SAPOData OAuth type authentication credentials.
 








Class com.amazonaws.services.appflow.model.SAPODataConnectorProfileProperties extends Object implements Serializable


Serialized Fields


applicationHostUrl
String applicationHostUrl

 The location of the SAPOData resource.
 


applicationServicePath
String applicationServicePath

 The application path to catalog service.
 


portNumber
Integer portNumber

 The port number of the SAPOData instance.
 


clientNumber
String clientNumber

 The client number for the client creating the connection.
 


logonLanguage
String logonLanguage

 The logon language of SAPOData instance.
 


privateLinkServiceName
String privateLinkServiceName

 The SAPOData Private Link service name to be used for private data transfers.
 


oAuthProperties
OAuthProperties oAuthProperties

 The SAPOData OAuth properties required for OAuth type authentication.
 


disableSSO
Boolean disableSSO

 If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your
 SAP account when it accesses your SAP OData instance.
 
 
 Whether you need this option depends on the types of credentials that you applied to your SAP OData connection
 profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from
 connecting to your account with your username and password. In this case, bypassing SSO makes it possible for
 Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no
 affect.
 








Class com.amazonaws.services.appflow.model.SAPODataDestinationProperties extends Object implements Serializable


Serialized Fields


objectPath
String objectPath

 The object path specified in the SAPOData flow destination.
 


successResponseHandlingConfig
SuccessResponseHandlingConfig successResponseHandlingConfig

 Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
 
 
 For example, this setting would determine where to write the response from a destination connector upon a
 successful insert operation.
 


idFieldNames
List<E> idFieldNames


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig


writeOperationType
String writeOperationType








Class com.amazonaws.services.appflow.model.SAPODataMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.SAPODataPaginationConfig extends Object implements Serializable


Serialized Fields


maxPageSize
Integer maxPageSize

 The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP
 application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes
 from an ODP provider, the maximum page size is 10,000.
 








Class com.amazonaws.services.appflow.model.SAPODataParallelismConfig extends Object implements Serializable


Serialized Fields


maxParallelism
Integer maxParallelism

 The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your
 SAP application.
 








Class com.amazonaws.services.appflow.model.SAPODataSourceProperties extends Object implements Serializable


Serialized Fields


objectPath
String objectPath

 The object path specified in the SAPOData flow source.
 


parallelismConfig
SAPODataParallelismConfig parallelismConfig

 Sets the number of concurrent processes that transfers OData records from your SAP instance.
 


paginationConfig
SAPODataPaginationConfig paginationConfig

 Sets the page size for each concurrent process that transfers OData records from your SAP instance.
 








Class com.amazonaws.services.appflow.model.ScheduledTriggerProperties extends Object implements Serializable


Serialized Fields


scheduleExpression
String scheduleExpression

 The scheduling expression that determines the rate at which the schedule will run, for example
 rate(5minutes).
 


dataPullMode
String dataPullMode

 Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow
 run.
 


scheduleStartTime
Date scheduleStartTime

 The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601
 standard, such as 2022-04-26T13:00:00-07:00.
 


scheduleEndTime
Date scheduleEndTime

 The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601
 standard, such as 2022-04-27T13:00:00-07:00.
 


timezone
String timezone

 Specifies the time zone used when referring to the dates and times of a scheduled flow, such as
 America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow
 interprets the timestamps that you specify to schedule the flow.
 
 
 If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset
 in your timestamps. For example, the UTC offsets for the America/New_York timezone are
 -04:00 EDT and -05:00 EST.
 


scheduleOffset
Long scheduleOffset

 Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
 


firstExecutionFrom
Date firstExecutionFrom

 Specifies the date range for the records to import from the connector in the first flow run.
 


flowErrorDeactivationThreshold
Integer flowErrorDeactivationThreshold

 Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
 








Class com.amazonaws.services.appflow.model.ServiceNowConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


username
String username

 The name of the user.
 


password
String password

 The password that corresponds to the user name.
 


oAuth2Credentials
OAuth2Credentials oAuth2Credentials

 The OAuth 2.0 credentials required to authenticate the user.
 








Class com.amazonaws.services.appflow.model.ServiceNowConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the ServiceNow resource.
 








Class com.amazonaws.services.appflow.model.ServiceNowMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.ServiceNowSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the ServiceNow flow source.
 








Class com.amazonaws.services.appflow.model.ServiceQuotaExceededException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.SingularConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


apiKey
String apiKey

 A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
 








Class com.amazonaws.services.appflow.model.SingularConnectorProfileProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.SingularMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.SingularSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Singular flow source.
 








Class com.amazonaws.services.appflow.model.SlackConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The credentials used to access protected Slack resources.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 








Class com.amazonaws.services.appflow.model.SlackConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Slack resource.
 








Class com.amazonaws.services.appflow.model.SlackMetadata extends Object implements Serializable


Serialized Fields


oAuthScopes
List<E> oAuthScopes

 The desired authorization scope for the Slack account.
 








Class com.amazonaws.services.appflow.model.SlackSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Slack flow source.
 








Class com.amazonaws.services.appflow.model.SnowflakeConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


username
String username

 The name of the user.
 


password
String password

 The password that corresponds to the user name.
 








Class com.amazonaws.services.appflow.model.SnowflakeConnectorProfileProperties extends Object implements Serializable


Serialized Fields


warehouse
String warehouse

 The name of the Snowflake warehouse.
 


stage
String stage

 The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account.
 This is written in the following format: < Database>< Schema><Stage Name>.
 


bucketName
String bucketName

 The name of the Amazon S3 bucket associated with Snowflake.
 


bucketPrefix
String bucketPrefix

 The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
 


privateLinkServiceName
String privateLinkServiceName

 The Snowflake Private Link service name to be used for private data transfers.
 


accountName
String accountName

 The name of the account.
 


region
String region

 The Amazon Web Services Region of the Snowflake account.
 








Class com.amazonaws.services.appflow.model.SnowflakeDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Snowflake flow destination.
 


intermediateBucketName
String intermediateBucketName

 The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
 


bucketPrefix
String bucketPrefix

 The object key for the destination bucket in which Amazon AppFlow places the files.
 


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig

 The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination.
 For example, this setting would determine if the flow should fail after one insertion error, or continue and
 attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of
 the destination connector details.
 








Class com.amazonaws.services.appflow.model.SnowflakeMetadata extends Object implements Serializable


Serialized Fields


supportedRegions
List<E> supportedRegions

 Specifies the supported Amazon Web Services Regions when using Snowflake.
 








Class com.amazonaws.services.appflow.model.SourceConnectorProperties extends Object implements Serializable


Serialized Fields


amplitude
AmplitudeSourceProperties amplitude

 Specifies the information that is required for querying Amplitude.
 


datadog
DatadogSourceProperties datadog

 Specifies the information that is required for querying Datadog.
 


dynatrace
DynatraceSourceProperties dynatrace

 Specifies the information that is required for querying Dynatrace.
 


googleAnalytics
GoogleAnalyticsSourceProperties googleAnalytics

 Specifies the information that is required for querying Google Analytics.
 


inforNexus
InforNexusSourceProperties inforNexus

 Specifies the information that is required for querying Infor Nexus.
 


marketo
MarketoSourceProperties marketo

 Specifies the information that is required for querying Marketo.
 


s3
S3SourceProperties s3

 Specifies the information that is required for querying Amazon S3.
 


salesforce
SalesforceSourceProperties salesforce

 Specifies the information that is required for querying Salesforce.
 


serviceNow
ServiceNowSourceProperties serviceNow

 Specifies the information that is required for querying ServiceNow.
 


singular
SingularSourceProperties singular

 Specifies the information that is required for querying Singular.
 


slack
SlackSourceProperties slack

 Specifies the information that is required for querying Slack.
 


trendmicro
TrendmicroSourceProperties trendmicro

 Specifies the information that is required for querying Trend Micro.
 


veeva
VeevaSourceProperties veeva

 Specifies the information that is required for querying Veeva.
 


zendesk
ZendeskSourceProperties zendesk

 Specifies the information that is required for querying Zendesk.
 


sAPOData
SAPODataSourceProperties sAPOData


customConnector
CustomConnectorSourceProperties customConnector


pardot
PardotSourceProperties pardot

 Specifies the information that is required for querying Salesforce Pardot.
 








Class com.amazonaws.services.appflow.model.SourceFieldProperties extends Object implements Serializable


Serialized Fields


isRetrievable
Boolean isRetrievable

 Indicates whether the field can be returned in a search result.
 


isQueryable
Boolean isQueryable

 Indicates if the field can be queried.
 


isTimestampFieldForIncrementalQueries
Boolean isTimestampFieldForIncrementalQueries

 Indicates if this timestamp field can be used for incremental queries.
 








Class com.amazonaws.services.appflow.model.SourceFlowConfig extends Object implements Serializable


Serialized Fields


connectorType
String connectorType

 The type of connector, such as Salesforce, Amplitude, and so on.
 


apiVersion
String apiVersion

 The API version of the connector when it's used as a source in the flow.
 


connectorProfileName
String connectorProfileName

 The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services
 account.
 


sourceConnectorProperties
SourceConnectorProperties sourceConnectorProperties

 Specifies the information that is required to query a particular source connector.
 


incrementalPullConfig
IncrementalPullConfig incrementalPullConfig

 Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields
 specified in the configuration are used when querying for the incremental data pull.
 








Class com.amazonaws.services.appflow.model.StartFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your StartFlow
 request completes only once. You choose the value to pass. For example, if you don't receive a response from your
 request, you can safely retry the request with the same clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs for flows that run on a
 schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the
 conditions that initiate your flow for the triggerConfig parameter.
 
 
 If you use a different value for clientToken, Amazon AppFlow considers it a new call to
 StartFlow. The token is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.StartFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn

 The flow's Amazon Resource Name (ARN).
 


flowStatus
String flowStatus

 Indicates the current status of the flow.
 


executionId
String executionId

 Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered
 flows, this value is null.
 








Class com.amazonaws.services.appflow.model.StopFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 








Class com.amazonaws.services.appflow.model.StopFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn

 The flow's Amazon Resource Name (ARN).
 


flowStatus
String flowStatus

 Indicates the current status of the flow.
 








Class com.amazonaws.services.appflow.model.SuccessResponseHandlingConfig extends Object implements Serializable


Serialized Fields


bucketPrefix
String bucketPrefix

 The Amazon S3 bucket prefix.
 


bucketName
String bucketName

 The name of the Amazon S3 bucket.
 








Class com.amazonaws.services.appflow.model.SupportedFieldTypeDetails extends Object implements Serializable


Serialized Fields


v1
FieldTypeDetails v1

 The initial supported version for fieldType. If this is later changed to a different version, v2
 will be introduced.
 








Class com.amazonaws.services.appflow.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the flow that you want to tag.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for your flow.
 








Class com.amazonaws.services.appflow.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


sourceFields
List<E> sourceFields

 The source fields to which a particular task is applied.
 


connectorOperator
ConnectorOperator connectorOperator

 The operation to be performed on the provided source fields.
 


destinationField
String destinationField

 A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
 


taskType
String taskType

 Specifies the particular task implementation that Amazon AppFlow performs.
 


taskProperties
Map<K,V> taskProperties

 A map used to store task-related information. The execution service looks for particular information based on the
 TaskType.
 








Class com.amazonaws.services.appflow.model.ThrottlingException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.TrendmicroConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


apiSecretKey
String apiSecretKey

 The Secret Access Key portion of the credentials.
 








Class com.amazonaws.services.appflow.model.TrendmicroConnectorProfileProperties extends Object implements Serializable




Class com.amazonaws.services.appflow.model.TrendmicroMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.TrendmicroSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Trend Micro flow source.
 








Class com.amazonaws.services.appflow.model.TriggerConfig extends Object implements Serializable


Serialized Fields


triggerType
String triggerType

 Specifies the type of flow trigger. This can be OnDemand, Scheduled, or
 Event.
 


triggerProperties
TriggerProperties triggerProperties

 Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these
 settings only apply to the Scheduled trigger type.
 








Class com.amazonaws.services.appflow.model.TriggerProperties extends Object implements Serializable


Serialized Fields


scheduled
ScheduledTriggerProperties scheduled

 Specifies the configuration details of a schedule-triggered flow as defined by the user.
 








Class com.amazonaws.services.appflow.model.UnregisterConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorLabel
String connectorLabel

 The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
 Services account.
 


forceDelete
Boolean forceDelete

 Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more
 connector profiles. The default value is false.
 








Class com.amazonaws.services.appflow.model.UnregisterConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appflow.model.UnsupportedOperationException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the flow that you want to untag.
 


tagKeys
List<E> tagKeys

 The tag keys associated with the tag that you want to remove from your flow.
 








Class com.amazonaws.services.appflow.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appflow.model.UpdateConnectorProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorProfileName
String connectorProfileName

 The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services
 account.
 


connectionMode
String connectionMode

 Indicates the connection mode and if it is public or private.
 


connectorProfileConfig
ConnectorProfileConfig connectorProfileConfig

 Defines the connector-specific profile configuration and credentials.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your
 UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if
 you don't receive a response from your request, you can safely retry the request with the same
 clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile
 . The token is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.UpdateConnectorProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorProfileArn
String connectorProfileArn

 The Amazon Resource Name (ARN) of the connector profile.
 








Class com.amazonaws.services.appflow.model.UpdateConnectorRegistrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorLabel
String connectorLabel

 The name of the connector. The name is unique for each connector registration in your AWS account.
 


description
String description

 A description about the update that you're applying to the connector.
 


connectorProvisioningConfig
ConnectorProvisioningConfig connectorProvisioningConfig


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your
 UpdateConnectorRegistration request completes only once. You choose the value to pass. For example,
 if you don't receive a response from your request, you can safely retry the request with the same
 clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to
 UpdateConnectorRegistration. The token is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.UpdateConnectorRegistrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectorArn
String connectorArn

 The ARN of the connector being updated.
 








Class com.amazonaws.services.appflow.model.UpdateFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowName
String flowName

 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
 


description
String description

 A description of the flow.
 


triggerConfig
TriggerConfig triggerConfig

 The trigger settings that determine how and when the flow runs.
 


sourceFlowConfig
SourceFlowConfig sourceFlowConfig


destinationFlowConfigList
List<E> destinationFlowConfigList

 The configuration that controls how Amazon AppFlow transfers data to the destination connector.
 


tasks
List<E> tasks

 A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
 


metadataCatalogConfig
MetadataCatalogConfig metadataCatalogConfig

 Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
 associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
 


clientToken
String clientToken

 The clientToken parameter is an idempotency token. It ensures that your UpdateFlow
 request completes only once. You choose the value to pass. For example, if you don't receive a response from your
 request, you can safely retry the request with the same clientToken parameter value.
 
 
 If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
 you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
 value for other use cases.
 
 
 If you specify input parameters that differ from your first request, an error occurs. If you use a different
 value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token
 is active for 8 hours.
 








Class com.amazonaws.services.appflow.model.UpdateFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowStatus
String flowStatus

 Indicates the current status of the flow.
 








Class com.amazonaws.services.appflow.model.UpsolverDestinationProperties extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
 


bucketPrefix
String bucketPrefix

 The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
 


s3OutputFormatConfig
UpsolverS3OutputFormatConfig s3OutputFormatConfig

 The configuration that determines how data is formatted when Upsolver is used as the flow destination.
 








Class com.amazonaws.services.appflow.model.UpsolverMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.UpsolverS3OutputFormatConfig extends Object implements Serializable


Serialized Fields


fileType
String fileType

 Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
 


prefixConfig
PrefixConfig prefixConfig


aggregationConfig
AggregationConfig aggregationConfig








Class com.amazonaws.services.appflow.model.ValidationException extends AmazonAppflowException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appflow.model.VeevaConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


username
String username

 The name of the user.
 


password
String password

 The password that corresponds to the user name.
 








Class com.amazonaws.services.appflow.model.VeevaConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Veeva resource.
 








Class com.amazonaws.services.appflow.model.VeevaMetadata extends Object implements Serializable




Class com.amazonaws.services.appflow.model.VeevaSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Veeva flow source.
 


documentType
String documentType

 The document type specified in the Veeva document extract flow.
 


includeSourceFiles
Boolean includeSourceFiles

 Boolean value to include source files in Veeva document extract flow.
 


includeRenditions
Boolean includeRenditions

 Boolean value to include file renditions in Veeva document extract flow.
 


includeAllVersions
Boolean includeAllVersions

 Boolean value to include All Versions of files in Veeva document extract flow.
 








Class com.amazonaws.services.appflow.model.ZendeskConnectorProfileCredentials extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The identifier for the desired client.
 


clientSecret
String clientSecret

 The client secret used by the OAuth client to authenticate to the authorization server.
 


accessToken
String accessToken

 The credentials used to access protected Zendesk resources.
 


oAuthRequest
ConnectorOAuthRequest oAuthRequest

 The OAuth requirement needed to request security tokens from the connector endpoint.
 








Class com.amazonaws.services.appflow.model.ZendeskConnectorProfileProperties extends Object implements Serializable


Serialized Fields


instanceUrl
String instanceUrl

 The location of the Zendesk resource.
 








Class com.amazonaws.services.appflow.model.ZendeskDestinationProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Zendesk flow destination.
 


idFieldNames
List<E> idFieldNames


errorHandlingConfig
ErrorHandlingConfig errorHandlingConfig


writeOperationType
String writeOperationType








Class com.amazonaws.services.appflow.model.ZendeskMetadata extends Object implements Serializable


Serialized Fields


oAuthScopes
List<E> oAuthScopes

 The desired authorization scope for the Zendesk account.
 








Class com.amazonaws.services.appflow.model.ZendeskSourceProperties extends Object implements Serializable


Serialized Fields


object
String object

 The object specified in the Zendesk flow source.
 








Package com.amazonaws.services.appintegrations.model




Class com.amazonaws.services.appintegrations.model.AccessDeniedException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.AmazonAppIntegrationsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.ApplicationAssociationSummary extends Object implements Serializable


Serialized Fields


applicationAssociationArn
String applicationAssociationArn

 The Amazon Resource Name (ARN) of the Application Association.
 


applicationArn
String applicationArn

 The Amazon Resource Name (ARN) of the Application.
 


clientId
String clientId

 The identifier for the client that is associated with the Application Association.
 








Class com.amazonaws.services.appintegrations.model.ApplicationSourceConfig extends Object implements Serializable


Serialized Fields


externalUrlConfig
ExternalUrlConfig externalUrlConfig

 The external URL source for the application.
 








Class com.amazonaws.services.appintegrations.model.ApplicationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 


id
String id

 A unique identifier for the Application.
 


name
String name

 The name of the application.
 


namespace
String namespace

 The namespace of the application.
 


createdTime
Date createdTime

 The time when the application was created.
 


lastModifiedTime
Date lastModifiedTime

 The time when the application was last modified.
 








Class com.amazonaws.services.appintegrations.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the application.
 


namespace
String namespace

 The namespace of the application.
 


description
String description

 The description of the application.
 


applicationSourceConfig
ApplicationSourceConfig applicationSourceConfig

 The configuration for where the application should be loaded from.
 


subscriptions
List<E> subscriptions
Deprecated. 

 The events that the application subscribes.
 


publications
List<E> publications
Deprecated. 

 The events that the application publishes.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
 the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
 idempotent APIs.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 


permissions
List<E> permissions

 The configuration of events or requests that the application has access to.
 








Class com.amazonaws.services.appintegrations.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 


id
String id

 A unique identifier for the Application.
 








Class com.amazonaws.services.appintegrations.model.CreateDataIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the DataIntegration.
 


description
String description

 A description of the DataIntegration.
 


kmsKey
String kmsKey

 The KMS key for the DataIntegration.
 


sourceURI
String sourceURI

 The URI of the data source.
 


scheduleConfig
ScheduleConfiguration scheduleConfig

 The name of the data and how often it should be pulled from the source.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
 the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
 idempotent APIs.
 


fileConfiguration
FileConfiguration fileConfiguration

 The configuration for what files should be pulled from the source.
 


objectConfiguration
Map<K,V> objectConfiguration

 The configuration for what data should be pulled from the source.
 








Class com.amazonaws.services.appintegrations.model.CreateDataIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN)
 


id
String id

 A unique identifier.
 


name
String name

 The name of the DataIntegration.
 


description
String description

 A description of the DataIntegration.
 


kmsKey
String kmsKey

 The KMS key for the DataIntegration.
 


sourceURI
String sourceURI

 The URI of the data source.
 


scheduleConfiguration
ScheduleConfiguration scheduleConfiguration

 The name of the data and how often it should be pulled from the source.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
 the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
 idempotent APIs.
 


fileConfiguration
FileConfiguration fileConfiguration

 The configuration for what files should be pulled from the source.
 


objectConfiguration
Map<K,V> objectConfiguration

 The configuration for what data should be pulled from the source.
 








Class com.amazonaws.services.appintegrations.model.CreateEventIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event integration.
 


description
String description

 The description of the event integration.
 


eventFilter
EventFilter eventFilter

 The event filter.
 


eventBridgeBus
String eventBridgeBus

 The EventBridge bus.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
 the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
 idempotent APIs.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 








Class com.amazonaws.services.appintegrations.model.CreateEventIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventIntegrationArn
String eventIntegrationArn

 The Amazon Resource Name (ARN) of the event integration.
 








Class com.amazonaws.services.appintegrations.model.DataIntegrationAssociationSummary extends Object implements Serializable


Serialized Fields


dataIntegrationAssociationArn
String dataIntegrationAssociationArn

 The Amazon Resource Name (ARN) of the DataIntegration association.
 


dataIntegrationArn
String dataIntegrationArn

 The Amazon Resource Name (ARN) of the DataIntegration.
 


clientId
String clientId

 The identifier for the client that is associated with the DataIntegration association.
 








Class com.amazonaws.services.appintegrations.model.DataIntegrationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the DataIntegration.
 


name
String name

 The name of the DataIntegration.
 


sourceURI
String sourceURI

 The URI of the data source.
 








Class com.amazonaws.services.appintegrations.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 








Class com.amazonaws.services.appintegrations.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.DeleteDataIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataIntegrationIdentifier
String dataIntegrationIdentifier

 A unique identifier for the DataIntegration.
 








Class com.amazonaws.services.appintegrations.model.DeleteDataIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.DeleteEventIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event integration.
 








Class com.amazonaws.services.appintegrations.model.DeleteEventIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.DuplicateResourceException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.EventFilter extends Object implements Serializable


Serialized Fields


source
String source

 The source of the events.
 








Class com.amazonaws.services.appintegrations.model.EventIntegration extends Object implements Serializable


Serialized Fields


eventIntegrationArn
String eventIntegrationArn

 The Amazon Resource Name (ARN) of the event integration.
 


name
String name

 The name of the event integration.
 


description
String description

 The event integration description.
 


eventFilter
EventFilter eventFilter

 The event integration filter.
 


eventBridgeBus
String eventBridgeBus

 The Amazon EventBridge bus for the event integration.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 








Class com.amazonaws.services.appintegrations.model.EventIntegrationAssociation extends Object implements Serializable


Serialized Fields


eventIntegrationAssociationArn
String eventIntegrationAssociationArn

 The Amazon Resource Name (ARN) for the event integration association.
 


eventIntegrationAssociationId
String eventIntegrationAssociationId

 The identifier for the event integration association.
 


eventIntegrationName
String eventIntegrationName

 The name of the event integration.
 


clientId
String clientId

 The identifier for the client that is associated with the event integration.
 


eventBridgeRuleName
String eventBridgeRuleName

 The name of the EventBridge rule.
 


clientAssociationMetadata
Map<K,V> clientAssociationMetadata

 The metadata associated with the client.
 








Class com.amazonaws.services.appintegrations.model.ExternalUrlConfig extends Object implements Serializable


Serialized Fields


accessUrl
String accessUrl

 The URL to access the application.
 


approvedOrigins
List<E> approvedOrigins

 Additional URLs to allow list if different than the access URL.
 








Class com.amazonaws.services.appintegrations.model.FileConfiguration extends Object implements Serializable


Serialized Fields


folders
List<E> folders

 Identifiers for the source folders to pull all files from recursively.
 


filters
Map<K,V> filters

 Restrictions for what files should be pulled from the source.
 








Class com.amazonaws.services.appintegrations.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 








Class com.amazonaws.services.appintegrations.model.GetApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 


id
String id

 A unique identifier for the Application.
 


name
String name

 The name of the application.
 


namespace
String namespace

 The namespace of the application.
 


description
String description

 The description of the application.
 


applicationSourceConfig
ApplicationSourceConfig applicationSourceConfig

 The configuration for where the application should be loaded from.
 


subscriptions
List<E> subscriptions
Deprecated. 

 The events that the application subscribes.
 


publications
List<E> publications
Deprecated. 

 The events that the application publishes.
 


createdTime
Date createdTime

 The created time of the Application.
 


lastModifiedTime
Date lastModifiedTime

 The last modified time of the Application.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 


permissions
List<E> permissions

 The configuration of events or requests that the application has access to.
 








Class com.amazonaws.services.appintegrations.model.GetDataIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identifier
String identifier

 A unique identifier.
 








Class com.amazonaws.services.appintegrations.model.GetDataIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) for the DataIntegration.
 


id
String id

 A unique identifier.
 


name
String name

 The name of the DataIntegration.
 


description
String description

 The KMS key for the DataIntegration.
 


kmsKey
String kmsKey

 The KMS key for the DataIntegration.
 


sourceURI
String sourceURI

 The URI of the data source.
 


scheduleConfiguration
ScheduleConfiguration scheduleConfiguration

 The name of the data and how often it should be pulled from the source.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 


fileConfiguration
FileConfiguration fileConfiguration

 The configuration for what files should be pulled from the source.
 


objectConfiguration
Map<K,V> objectConfiguration

 The configuration for what data should be pulled from the source.
 








Class com.amazonaws.services.appintegrations.model.GetEventIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event integration.
 








Class com.amazonaws.services.appintegrations.model.GetEventIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the event integration.
 


description
String description

 The description of the event integration.
 


eventIntegrationArn
String eventIntegrationArn

 The Amazon Resource Name (ARN) for the event integration.
 


eventBridgeBus
String eventBridgeBus

 The EventBridge bus.
 


eventFilter
EventFilter eventFilter

 The event filter.
 


tags
Map<K,V> tags

 The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 








Class com.amazonaws.services.appintegrations.model.InternalServiceErrorException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.InvalidRequestException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.ListApplicationAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 A unique identifier for the Application.
 


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListApplicationAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationAssociations
List<E> applicationAssociations

 List of Application Associations for the Application.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.appintegrations.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applications
List<E> applications

 The Applications associated with this account.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.appintegrations.model.ListDataIntegrationAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataIntegrationIdentifier
String dataIntegrationIdentifier

 A unique identifier for the DataIntegration.
 


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListDataIntegrationAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataIntegrationAssociations
List<E> dataIntegrationAssociations

 The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.appintegrations.model.ListDataIntegrationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListDataIntegrationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataIntegrations
List<E> dataIntegrations

 The DataIntegrations associated with this account.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.appintegrations.model.ListEventIntegrationAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventIntegrationName
String eventIntegrationName

 The name of the event integration.
 


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListEventIntegrationAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventIntegrationAssociations
List<E> eventIntegrationAssociations

 The event integration associations.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.appintegrations.model.ListEventIntegrationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 maximum number of results to return per page.
 








Class com.amazonaws.services.appintegrations.model.ListEventIntegrationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventIntegrations
List<E> eventIntegrations

 The event integrations.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 








Class com.amazonaws.services.appintegrations.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 Information about the tags.
 








Class com.amazonaws.services.appintegrations.model.Publication extends Object implements Serializable


Serialized Fields


event
String event

 The name of the publication.
 


schema
String schema

 The JSON schema of the publication event.
 


description
String description

 The description of the publication.
 








Class com.amazonaws.services.appintegrations.model.ResourceNotFoundException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.ResourceQuotaExceededException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.ScheduleConfiguration extends Object implements Serializable


Serialized Fields


firstExecutionFrom
String firstExecutionFrom

 The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in
 ISO-8601 format.
 


object
String object

 The name of the object to pull from the data source.
 


scheduleExpression
String scheduleExpression

 How often the data should be pulled from data source.
 








Class com.amazonaws.services.appintegrations.model.Subscription extends Object implements Serializable


Serialized Fields


event
String event

 The name of the subscription.
 


description
String description

 The description of the subscription.
 








Class com.amazonaws.services.appintegrations.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 used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1",
 "key2":"value2"} }.
 








Class com.amazonaws.services.appintegrations.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.ThrottlingException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.model.UnsupportedOperationException extends AmazonAppIntegrationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appintegrations.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.appintegrations.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Application.
 


name
String name

 The name of the application.
 


description
String description

 The description of the application.
 


applicationSourceConfig
ApplicationSourceConfig applicationSourceConfig

 The configuration for where the application should be loaded from.
 


subscriptions
List<E> subscriptions
Deprecated. 

 The events that the application subscribes.
 


publications
List<E> publications
Deprecated. 

 The events that the application publishes.
 


permissions
List<E> permissions

 The configuration of events or requests that the application has access to.
 








Class com.amazonaws.services.appintegrations.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.UpdateDataIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identifier
String identifier

 A unique identifier for the DataIntegration.
 


name
String name

 The name of the DataIntegration.
 


description
String description

 A description of the DataIntegration.
 








Class com.amazonaws.services.appintegrations.model.UpdateDataIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appintegrations.model.UpdateEventIntegrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event integration.
 


description
String description

 The description of the event integration.
 








Class com.amazonaws.services.appintegrations.model.UpdateEventIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's
 returned by a call to ListMetrics.
 


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. For a complete list of the units that CloudWatch supports, see the MetricDatum data
 type in the Amazon CloudWatch API Reference.
 


metrics
List<E> metrics

 The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw
 metric and metric math expressions.
 








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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 








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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 








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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 








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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


resourceIds
List<E> resourceIds

 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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


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.
 


includeNotScaledActivities
Boolean includeNotScaledActivities

 Specifies whether to include activities that aren't scaled (not scaled activities) in the response. Not
 scaled activities are activities that aren't completed or started for various reasons, such as preventing
 infinite scaling loops. For help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.
 








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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


maxResults
Integer maxResults

 The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10.
 
 
 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 10 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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


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.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Specify the ARN of the scalable target.
 
 
 For example:
 arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
 
 
 To get the ARN for a scalable target, use DescribeScalableTargets.
 








Class com.amazonaws.services.applicationautoscaling.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 A list of tags. Each tag consists of a tag key and a tag value.
 








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.NotScaledReason extends Object implements Serializable


Serialized Fields


code
String code

 A code that represents the reason for not scaling.
 
 
 Valid values:
 
 
 
 
 AutoScalingAnticipatedFlapping
 
 
 
 
 TargetServicePutResourceAsUnscalable
 
 
 
 
 AlreadyAtMaxCapacity
 
 
 
 
 AlreadyAtMinCapacity
 
 
 
 
 AlreadyAtDesiredCapacity
 
 
 


maxCapacity
Integer maxCapacity

 The maximum capacity.
 


minCapacity
Integer minCapacity

 The minimum capacity.
 


currentCapacity
Integer currentCapacity

 The current capacity.
 








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 Fleets 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 or ECS
 service.
 
 
 You create the resource label by appending the final portion of the load balancer ARN and the final portion of
 the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
 
 
 app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
 
 
 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.
 
 
 
 
 To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
 








Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the scaling policy.
 
 
 You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new
 scaling policy with the same settings and a different name.
 


serviceNamespace
String serviceNamespace

 The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


policyType
String policyType

 The scaling 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, Lambda, Amazon Keyspaces, Amazon MSK,
 Amazon ElastiCache, or Neptune.
 
 
 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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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. Cron expressions are useful for scheduled actions that run
 periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a
 regular interval.
 
 
 At and cron expressions use Universal Coordinated Time (UTC) by default.
 
 
 The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month]
 [Day_of_Week] [Year].
 
 
 For rate expressions, value is a positive integer and unit is minute |
 minutes | hour | hours | day | days.
 
 
 For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
 


timezone
String timezone

 Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is
 not provided, UTC is used by default.
 
 
 Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as
 Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.
 


scheduledActionName
String scheduledActionName

 The name of the scheduled action. This name must be unique among all other scheduled actions on the specified
 scalable target.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


startTime
Date startTime

 The date and time for this scheduled action to start, in UTC.
 


endTime
Date endTime

 The date and time for the recurring schedule to end, in UTC.
 


scalableTargetAction
ScalableTargetAction scalableTargetAction

 The new minimum and maximum capacity. You can set both values or just one. At 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 Amazon Web Services service that provides the resource. For a resource provided by your own
 application or service, use custom-resource instead.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


minCapacity
Integer minCapacity

 The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can
 scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is
 required when registering a new scalable target.
 
 
 For the following resources, the minimum value allowed is 0.
 
 
 
 
 AppStream 2.0 fleets
 
 
 
 
 Aurora DB clusters
 
 
 
 
 ECS services
 
 
 
 
 EMR clusters
 
 
 
 
 Lambda provisioned concurrency
 
 
 
 
 SageMaker endpoint variants
 
 
 
 
 SageMaker inference components
 
 
 
 
 SageMaker serverless endpoint provisioned concurrency
 
 
 
 
 Spot Fleets
 
 
 
 
 custom resources
 
 
 
 
 It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points
 are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU
 utilization.
 
 
 For all other resources, the minimum allowed value depends on the type of resource that you are using. If you
 provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message
 will provide the minimum value that the resource can accept.
 


maxCapacity
Integer maxCapacity

 The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can
 scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is
 required when registering a new scalable target.
 
 
 Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each
 service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher
 limit, you can request an increase. For more information, consult the documentation for that service. For
 information about the default quotas for each service, see Service endpoints and
 quotas in the Amazon Web Services General Reference.
 


roleARN
String roleARN

 This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it
 must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your
 behalf.
 
 
 If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it
 creates if it does not yet exist. For more information, see How
 Application Auto Scaling works with IAM.
 


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 Suspend and resume scaling in the Application Auto Scaling User Guide.
 


tags
Map<K,V> tags

 Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is
 created. To tag an existing scalable target, use the TagResource operation.
 
 
 Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have
 more than one tag on a scalable target with the same tag key.
 
 
 Use tags to control access to a scalable target. For more information, see Tagging
 support for Application Auto Scaling in the Application Auto Scaling User Guide.
 








Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scalableTargetARN
String scalableTargetARN

 The ARN of the scalable target.
 








Class com.amazonaws.services.applicationautoscaling.model.ResourceNotFoundException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName

 The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).
 








Class com.amazonaws.services.applicationautoscaling.model.ScalableTarget extends Object implements Serializable


Serialized Fields


serviceNamespace
String serviceNamespace

 The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


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 task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


minCapacity
Integer minCapacity

 The minimum value to scale to in response to a scale-in activity.
 


maxCapacity
Integer maxCapacity

 The maximum value to scale to in response to a scale-out activity.
 


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

 Specifies whether the scaling activities for a scalable target are in a suspended state.
 


scalableTargetARN
String scalableTargetARN

 The ARN of the scalable target.
 








Class com.amazonaws.services.applicationautoscaling.model.ScalableTargetAction extends Object implements Serializable


Serialized Fields


minCapacity
Integer minCapacity

 The minimum capacity.
 
 
 When the scheduled action runs, the resource will have at least this much capacity, but it might have more
 depending on other settings, such as the target utilization level of a target tracking scaling policy.
 


maxCapacity
Integer maxCapacity

 The maximum capacity.
 
 
 Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service
 has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you
 can request an increase. For more information, consult the documentation for that service. For information about
 the default quotas for each service, see Service endpoints and
 quotas in the Amazon Web Services General Reference.
 








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 Amazon Web Services service that provides the resource, or a custom-resource.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


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.
 


notScaledReasons
List<E> notScaledReasons

 Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.
 








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 Amazon Web Services service that provides the resource, or a custom-resource.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


policyType
String policyType

 The scaling policy type.
 
 
 The following policy types are supported:
 
 
 TargetTrackingScaling—Not supported for Amazon EMR
 
 
 StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK,
 Amazon ElastiCache, or Neptune.
 


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 Amazon Web Services service that provides the resource, or a custom-resource.
 


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. Cron expressions are useful for scheduled actions that run
 periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a
 regular interval.
 
 
 At and cron expressions use Universal Coordinated Time (UTC) by default.
 
 
 The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month]
 [Day_of_Week] [Year].
 
 
 For rate expressions, value is a positive integer and unit is minute |
 minutes | hour | hours | day | days.
 
 
 For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
 


timezone
String timezone

 The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an
 at or cron expression.
 


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/my-cluster/my-service.
 
 
 
 
 Spot Fleet - 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.
 
 
 
 
 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.
 
 
 
 
 Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
 endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-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.
 
 
 
 
 Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
 Example: keyspace/mykeyspace/table/mytable.
 
 
 
 
 Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
 arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
 
 
 
 
 Amazon ElastiCache replication group - The resource type is replication-group and the unique
 identifier is the replication group name. Example: replication-group/mycluster.
 
 
 
 
 Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
 Example: cluster:mycluster.
 
 
 
 
 SageMaker serverless endpoint - The resource type is variant and the unique identifier is the
 resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
 
 
 
 
 SageMaker inference component - The resource type is inference-component and the unique identifier
 is the resource ID. Example: inference-component/my-inference-component.
 
 
 
 
 Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID.
 Example: workspacespool/wspool-123456.
 
 
 


scalableDimension
String scalableDimension

 The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
 
 
 
 
 ecs:service:DesiredCount - The task count of an ECS service.
 
 
 
 
 elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
 
 
 
 
 ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
 
 
 
 
 appstream:fleet:DesiredCapacity - The 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 a 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.
 
 
 
 
 comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
 Amazon Comprehend entity recognizer endpoint.
 
 
 
 
 lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
 
 
 
 
 cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
 
 
 
 
 cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
 
 
 
 
 kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
 cluster.
 
 
 
 
 elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
 replication group.
 
 
 
 
 elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
 ElastiCache replication group.
 
 
 
 
 neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
 
 
 
 
 sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
 serverless endpoint.
 
 
 
 
 sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a
 SageMaker inference component.
 
 
 
 
 workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in
 the pool.
 
 
 


startTime
Date startTime

 The date and time that the action is scheduled to begin, in UTC.
 


endTime
Date endTime

 The date and time that the action is scheduled to end, in UTC.
 


scalableTargetAction
ScalableTargetAction scalableTargetAction

 The new minimum and maximum capacity. You can set both values or just one. At 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's 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's 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. For exact capacity, you must specify a
 non-negative value.
 








Class com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration extends Object implements Serializable


Serialized Fields


adjustmentType
String adjustmentType

 Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are
 ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
 
 
 AdjustmentType is required if you are adding a new step scaling policy configuration.
 


stepAdjustments
List<E> stepAdjustments

 A set of adjustments that enable you to scale based on the size of the alarm breach.
 
 
 At least one step adjustment is required if you are adding a new step scaling policy configuration.
 


minAdjustmentMagnitude
Integer minAdjustmentMagnitude

 The minimum value to scale by when the adjustment type is PercentChangeInCapacity. 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, to wait for a previous scaling activity to take effect. If not specified, the
 default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
 


metricAggregationType
String metricAggregationType

 The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and
 Average. If the aggregation type is null, the value is treated as Average.
 








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.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Identifies the Application Auto Scaling scalable target that you want to apply tags to.
 
 
 For example:
 arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
 
 
 To get the ARN for a scalable target, use DescribeScalableTargets.
 


tags
Map<K,V> tags

 The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.
 
 
 Each tag consists of a tag key and a tag value.
 
 
 You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you
 specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value
 with the specified one.
 
 
 For information about the rules that apply to tag keys and tag values, see User-defined
 tag restrictions in the Amazon Web Services Billing User Guide.
 








Class com.amazonaws.services.applicationautoscaling.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetric extends Object implements Serializable


Serialized Fields


dimensions
List<E> dimensions

 The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation
 available from the table in Amazon
 Web Services services that publish CloudWatch metrics  in the Amazon CloudWatch User Guide.
 
 
 Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling
 policy.
 


metricName
String metricName

 The name of the metric.
 


namespace
String namespace

 The namespace of the metric. For more information, see the table in Amazon
 Web Services services that publish CloudWatch metrics  in the Amazon CloudWatch User Guide.
 








Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetricDataQuery extends Object implements Serializable


Serialized Fields


expression
String expression

 The math expression to perform 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.
 
 
 Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either
 Expression or MetricStat, but not both.
 


id
String id

 A short name that identifies the object's results in the response. This name must be unique among all
 MetricDataQuery objects specified for a single scaling policy. 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 underscores. The first character must be a lowercase
 letter.
 


label
String label

 A human-readable label for this metric or expression. This is especially useful if this is a math expression, so
 that you know what the value represents.
 


metricStat
TargetTrackingMetricStat metricStat

 Information about the metric data to return.
 
 
 Conditional: Within each MetricDataQuery object, you must specify either Expression or
 MetricStat, but not both.
 


returnData
Boolean returnData

 Indicates whether to return the timestamps and raw data values of this metric.
 
 
 If you use any math expressions, specify true for this value for only the final math expression that
 the metric specification is based on. You must specify false for ReturnData for all the
 other metrics and expressions used in the metric specification.
 
 
 If you are only retrieving metrics and not performing any math expressions, do not specify anything for
 ReturnData. This sets it to its default (true).
 








Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetricDimension 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.TargetTrackingMetricStat extends Object implements Serializable


Serialized Fields


metric
TargetTrackingMetric metric

 The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric
 name, namespace, and dimensions, inspect the Metric object that is
 returned by a call to ListMetrics.
 


stat
String stat

 The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid
 values, see the table in Statistics in the Amazon CloudWatch User Guide.
 
 
 The most commonly used metric for scaling is Average.
 


unit
String unit

 The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the
 MetricDatum
 data type in the Amazon CloudWatch API Reference.
 








Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration extends Object implements Serializable


Serialized Fields


targetValue
Double targetValue

 The target value for the metric. Although this property accepts numbers of type Double, it won't accept values
 that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid
 number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a
 percent value that represents how much of the CPU can be used before scaling out.
 
 
 
 If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target
 utilization as the optimal average request count per target during any one-minute interval.
 
 


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, to wait for a previous scale-out activity to take effect. For more information
 and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
 


scaleInCooldown
Integer scaleInCooldown

 The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
 For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
 


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 target.
 Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable
 target. The default value is false.
 








Class com.amazonaws.services.applicationautoscaling.model.TooManyTagsException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName

 The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).
 








Class com.amazonaws.services.applicationautoscaling.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Identifies the Application Auto Scaling scalable target from which to remove tags.
 
 
 For example:
 arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
 
 
 To get the ARN for a scalable target, use DescribeScalableTargets.
 


tagKeys
List<E> tagKeys

 One or more tag keys. Specify only the tag keys, not the tag values.
 








Class com.amazonaws.services.applicationautoscaling.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationautoscaling.model.ValidationException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.applicationcostprofiler.model




Class com.amazonaws.services.applicationcostprofiler.model.AccessDeniedException extends AWSApplicationCostProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationcostprofiler.model.AWSApplicationCostProfilerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationcostprofiler.model.DeleteReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportId
String reportId

 Required. ID of the report to delete.
 








Class com.amazonaws.services.applicationcostprofiler.model.DeleteReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportId
String reportId

 ID of the report that was deleted.
 








Class com.amazonaws.services.applicationcostprofiler.model.GetReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportId
String reportId

 ID of the report to retrieve.
 








Class com.amazonaws.services.applicationcostprofiler.model.GetReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportId
String reportId

 ID of the report retrieved.
 


reportDescription
String reportDescription

 Description of the report.
 


reportFrequency
String reportFrequency

 Cadence used to generate the report.
 


format
String format

 Format of the generated report.
 


destinationS3Location
S3Location destinationS3Location

 Amazon Simple Storage Service (Amazon S3) location where the report is uploaded.
 


createdAt
Date createdAt

 Timestamp (milliseconds) when this report definition was created.
 


lastUpdated
Date lastUpdated

 Timestamp (milliseconds) when this report definition was last updated.
 








Class com.amazonaws.services.applicationcostprofiler.model.ImportApplicationUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceS3Location
SourceS3Location sourceS3Location

 Amazon S3 location to import application usage data from.
 








Class com.amazonaws.services.applicationcostprofiler.model.ImportApplicationUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


importId
String importId

 ID of the import request.
 








Class com.amazonaws.services.applicationcostprofiler.model.InternalServerException extends AWSApplicationCostProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationcostprofiler.model.ListReportDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token value from a previous call to access the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 








Class com.amazonaws.services.applicationcostprofiler.model.ListReportDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportDefinitions
List<E> reportDefinitions

 The retrieved reports.
 


nextToken
String nextToken

 The value of the next token, if it exists. Null if there are no more results.
 








Class com.amazonaws.services.applicationcostprofiler.model.PutReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportId
String reportId

 Required. ID of the report. You can choose any valid string matching the pattern for the ID.
 


reportDescription
String reportDescription

 Required. Description of the report.
 


reportFrequency
String reportFrequency

 Required. The cadence to generate the report.
 


format
String format

 Required. The format to use for the generated report.
 


destinationS3Location
S3Location destinationS3Location

 Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report.
 








Class com.amazonaws.services.applicationcostprofiler.model.PutReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportId
String reportId

 ID of the report.
 








Class com.amazonaws.services.applicationcostprofiler.model.ReportDefinition extends Object implements Serializable


Serialized Fields


reportId
String reportId

 The ID of the report.
 


reportDescription
String reportDescription

 Description of the report
 


reportFrequency
String reportFrequency

 The cadence at which the report is generated.
 


format
String format

 The format used for the generated reports.
 


destinationS3Location
S3Location destinationS3Location

 The location in Amazon Simple Storage Service (Amazon S3) the reports should be saved to.
 


createdAt
Date createdAt

 Timestamp (milliseconds) when this report definition was created.
 


lastUpdatedAt
Date lastUpdatedAt

 Timestamp (milliseconds) when this report definition was last updated.
 








Class com.amazonaws.services.applicationcostprofiler.model.S3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 Name of the S3 bucket.
 


prefix
String prefix

 Prefix for the location to write to.
 








Class com.amazonaws.services.applicationcostprofiler.model.ServiceQuotaExceededException extends AWSApplicationCostProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationcostprofiler.model.SourceS3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 Name of the bucket.
 


key
String key

 Key of the object.
 


region
String region

 Region of the bucket. Only required for Regions that are disabled by default. For more infomration about Regions
 that are disabled by default, see  Enabling a Region
 in the AWS General Reference guide.
 








Class com.amazonaws.services.applicationcostprofiler.model.ThrottlingException extends AWSApplicationCostProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationcostprofiler.model.UpdateReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportId
String reportId

 Required. ID of the report to update.
 


reportDescription
String reportDescription

 Required. Description of the report.
 


reportFrequency
String reportFrequency

 Required. The cadence to generate the report.
 


format
String format

 Required. The format to use for the generated report.
 


destinationS3Location
S3Location destinationS3Location

 Required. Amazon Simple Storage Service (Amazon S3) location where Application Cost Profiler uploads the report.
 








Class com.amazonaws.services.applicationcostprofiler.model.UpdateReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportId
String reportId

 ID of the report.
 








Class com.amazonaws.services.applicationcostprofiler.model.ValidationException extends AWSApplicationCostProfilerException 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 ID.
 


operationSucceeded
Boolean operationSucceeded

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


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


hostName
String hostName

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


agentNetworkInfoList
List<E> agentNetworkInfoList

 Network details about the host where the agent or collector resides.
 


connectorId
String connectorId

 The ID of the connector.
 


version
String version

 The agent or collector version.
 


health
String health

 The health of the agent.
 


lastHealthPingTime
String lastHealthPingTime

 Time since agent health was reported.
 


collectionStatus
String collectionStatus

 Status of the collection process for an agent.
 


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


macAddress
String macAddress

 The MAC address for the host where the agent/collector 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.BatchDeleteAgentError extends Object implements Serializable


Serialized Fields


agentId
String agentId

 The ID of the agent or data collector to delete.
 


errorMessage
String errorMessage

 The description of the error that occurred for the delete failed agent.
 


errorCode
String errorCode

 The type of error that occurred for the delete failed agent. Valid status are: AGENT_IN_USE | NOT_FOUND |
 INTERNAL_SERVER_ERROR.
 








Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteAgentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deleteAgents
List<E> deleteAgents

 The list of agents to delete.
 








Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 A list of agent IDs that failed to delete during the deletion task, each paired with an error message.
 








Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteConfigurationTask extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The deletion task's unique identifier.
 


status
String status

 The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING |
 COMPLETED | FAILED.
 


startTime
Date startTime

 An epoch seconds timestamp (UTC) of when the deletion task was started.
 


endTime
Date endTime

 An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.
 


configurationType
String configurationType

 The type of configuration item to delete. Supported types are: SERVER.
 


requestedConfigurations
List<E> requestedConfigurations

 The list of configuration IDs that were originally requested to be deleted by the deletion task.
 


deletedConfigurations
List<E> deletedConfigurations

 The list of configuration IDs that were successfully deleted by the deletion task.
 


failedConfigurations
List<E> failedConfigurations

 A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.
 


deletionWarnings
List<E> deletionWarnings

 A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.
 








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.
 


deleteHistory
Boolean deleteHistory

 Set to true to remove the deleted import task from DescribeImportTasks.
 








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 Amazon Web
 Services administrator for help. For more information, see Setting Up Amazon Web
 Services 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 user is missing the Amazon
 Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again.
 For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery
 Service User Guide.
 
 
 
 
 FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your 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 Amazon Web Services Support.
 
 
 
 
 LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export.
 For more information, see  Upgrading Amazon Web
 Services Glue Data Permissions to the Amazon Web Services Lake Formation Model  in the Amazon Web Services
 Lake Formation Developer Guide.
 
 
 You can use one of the following two ways to resolve this issue.
 
 
 
 
 If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to
 use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more
 information, see Change Data Catalog Settings in the Lake Formation Developer Guide.
 
 
 
 
 You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and
 AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see  Granting Database
 Permissions in the Lake Formation Developer Guide.
 
 
 
 
 AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives
 the role database creation ability and implicit permissions for any created tables. For more information, see  Implicit Lake Formation
 Permissions  in the Lake Formation Developer Guide.
 
 
 
 
 AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.
 
 
 
 
 
 
 
 
 S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of 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.CustomerAgentlessCollectorInfo extends Object implements Serializable


Serialized Fields


activeAgentlessCollectors
Integer activeAgentlessCollectors

 The number of active Agentless Collector collectors.
 


healthyAgentlessCollectors
Integer healthyAgentlessCollectors

 The number of healthy Agentless Collector collectors.
 


denyListedAgentlessCollectors
Integer denyListedAgentlessCollectors

 The number of deny-listed Agentless Collector collectors.
 


shutdownAgentlessCollectors
Integer shutdownAgentlessCollectors

 The number of Agentless Collector collectors with SHUTDOWN status.
 


unhealthyAgentlessCollectors
Integer unhealthyAgentlessCollectors

 The number of unhealthy Agentless Collector collectors.
 


totalAgentlessCollectors
Integer totalAgentlessCollectors

 The total number of Agentless Collector collectors.
 


unknownAgentlessCollectors
Integer unknownAgentlessCollectors

 The number of unknown Agentless Collector collectors.
 








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.CustomerMeCollectorInfo extends Object implements Serializable


Serialized Fields


activeMeCollectors
Integer activeMeCollectors

 The number of active Migration Evaluator collectors.
 


healthyMeCollectors
Integer healthyMeCollectors

 The number of healthy Migration Evaluator collectors.
 


denyListedMeCollectors
Integer denyListedMeCollectors

 The number of deny-listed Migration Evaluator collectors.
 


shutdownMeCollectors
Integer shutdownMeCollectors

 The number of Migration Evaluator collectors with SHUTDOWN status.
 


unhealthyMeCollectors
Integer unhealthyMeCollectors

 The number of unhealthy Migration Evaluator collectors.
 


totalMeCollectors
Integer totalMeCollectors

 The total number of Migration Evaluator collectors.
 


unknownMeCollectors
Integer unknownMeCollectors

 The number of unknown Migration Evaluator collectors.
 








Class com.amazonaws.services.applicationdiscovery.model.DeleteAgent extends Object implements Serializable


Serialized Fields


agentId
String agentId

 The ID of the agent or data collector to delete.
 


force
Boolean force

 Optional flag used to force delete an agent or data collector. It is needed to delete any agent in
 HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be
 re-registered with a different agent ID after data collector re-connects with Amazon Web Services.
 








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.DeletionWarning extends Object implements Serializable


Serialized Fields


configurationId
String configurationId

 The unique identifier of the configuration that produced a warning.
 


warningCode
Integer warningCode

 The integer warning code associated with the warning message.
 


warningText
String warningText

 A descriptive message of the warning the associated configuration ID produced.
 








Class com.amazonaws.services.applicationdiscovery.model.DescribeAgentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentIds
List<E> agentIds

 The agent or the collector IDs for which you want information. If you specify no IDs, the system returns
 information about all agents/collectors associated with your user.
 


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/collectors 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 collector by ID or lists all agents/collectors associated with your user, if you did not
 specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC)
 addresses, agent/collector health, host name where the agent/collector resides, and the version number of each
 agent/collector.
 


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.DescribeBatchDeleteConfigurationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the task to delete.
 








Class com.amazonaws.services.applicationdiscovery.model.DescribeBatchDeleteConfigurationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


task
BatchDeleteConfigurationTask task

 The BatchDeleteConfigurationTask that represents the deletion task being executed.
 








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.Ec2RecommendationsExportPreferences extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 If set to true, the export preferences is set to Ec2RecommendationsExportPreferences.
 


cpuPerformanceMetricBasis
UsageMetricBasis cpuPerformanceMetricBasis

 The recommended EC2 instance type that matches the CPU usage metric of server performance data.
 


ramPerformanceMetricBasis
UsageMetricBasis ramPerformanceMetricBasis

 The recommended EC2 instance type that matches the Memory usage metric of server performance data.
 


tenancy
String tenancy

 The target tenancy to use for your recommended EC2 instances.
 


excludedInstanceTypes
List<E> excludedInstanceTypes

 An array of instance types to exclude from recommendations.
 


preferredRegion
String preferredRegion

 The target Amazon Web Services Region for the recommendations. You can use any of the Region codes available for
 the chosen service, as listed in Amazon Web
 Services service endpoints in the Amazon Web Services General Reference.
 


reservedInstanceOptions
ReservedInstanceOptions reservedInstanceOptions

 The contract type for a reserved instance. If blank, we assume an On-Demand instance is preferred.
 








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


values
List<E> values

 A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID 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.ExportPreferences extends Object implements Serializable


Serialized Fields


ec2RecommendationsPreferences
Ec2RecommendationsExportPreferences ec2RecommendationsPreferences

 If enabled, exported data includes EC2 instance type matches for on-premises servers discovered through Amazon
 Web Services Application Discovery Service.
 








Class com.amazonaws.services.applicationdiscovery.model.FailedConfiguration extends Object implements Serializable


Serialized Fields


configurationId
String configurationId

 The unique identifier of the configuration the failed to delete.
 


errorStatusCode
Integer errorStatusCode

 The integer error code associated with the error message.
 


errorMessage
String errorMessage

 A descriptive message indicating why the associated configuration failed to delete.
 








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.
 


meCollectorSummary
CustomerMeCollectorInfo meCollectorSummary

 Details about Migration Evaluator collectors, including collector status and health.
 


agentlessCollectorSummary
CustomerAgentlessCollectorInfo agentlessCollectorSummary

 Details about Agentless Collector collectors, including status.
 








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 Amazon
 Web Services 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.LimitExceededException 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 Amazon Web Services 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 Amazon Web Services 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.ReservedInstanceOptions extends Object implements Serializable


Serialized Fields


purchasingOption
String purchasingOption

 The payment plan to use for your Reserved Instance.
 


offeringClass
String offeringClass

 The flexibility to change the instance types needed for your Reserved Instance.
 


termLength
String termLength

 The preferred duration of the Reserved Instance term.
 








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.StartBatchDeleteConfigurationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationType
String configurationType

 The type of configuration item to delete. Supported types are: SERVER.
 


configurationIds
List<E> configurationIds

 The list of configuration IDs that will be deleted by the task.
 








Class com.amazonaws.services.applicationdiscovery.model.StartBatchDeleteConfigurationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier associated with the newly started deletion task.
 








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 from which to start collecting data. If you send a request to an agent ID that you do not
 have permission to contact, according to your Amazon Web Services account, the service does not throw an
 exception. Instead, it returns the error in the Description field. If you send a request to multiple
 agents and you do not have permission to contact some of those agents, the system does not throw an exception.
 Instead, the system shows Failed in the Description field.
 








Class com.amazonaws.services.applicationdiscovery.model.StartDataCollectionByAgentIdsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentsConfigurationStatus
List<E> agentsConfigurationStatus

 Information about agents that were instructed to start collecting data. Information includes the agent ID, a
 description of the operation performed, and whether the agent 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 Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary
 data from Application Discovery Agent 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.
 


preferences
ExportPreferences preferences

 Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.
 








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 Amazon Web Services 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 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 that were instructed to stop collecting data. Information includes the agent ID, a
 description of the operation performed, and whether the agent 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




Class com.amazonaws.services.applicationdiscovery.model.UsageMetricBasis extends Object implements Serializable


Serialized Fields


name
String name

 A utilization metric that is used by the recommendations.
 


percentageAdjust
Double percentageAdjust

 Specifies the percentage of the specified utilization metric that is used by the recommendations.
 








Package com.amazonaws.services.applicationinsights.model




Class com.amazonaws.services.applicationinsights.model.AccessDeniedException extends AmazonApplicationInsightsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationinsights.model.AddWorkloadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


componentName
String componentName

 The name of the component.
 


workloadConfiguration
WorkloadConfiguration workloadConfiguration

 The configuration settings of the workload. The value is the escaped JSON of the configuration.
 








Class com.amazonaws.services.applicationinsights.model.AddWorkloadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workloadId
String workloadId

 The ID of the workload.
 


workloadConfiguration
WorkloadConfiguration workloadConfiguration

 The configuration settings of the workload. The value is the escaped JSON of the configuration.
 








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.
 


componentRemarks
String componentRemarks

 If logging is supported for the resource type, indicates whether the component has configured logs to be
 monitored.
 


resourceType
String resourceType

 The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application
 ELB, and SQS Queue.
 


osType
String osType

 The operating system of the component.
 


tier
String tier

 The stack tier of the application component.
 


monitor
Boolean monitor

 Indicates whether the application component is monitored.
 


detectedWorkload
Map<K,V> detectedWorkload

 Workloads detected in the application component.
 








Class com.amazonaws.services.applicationinsights.model.ApplicationInfo extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account ID for the owner of the application.
 


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.
 


cWEMonitorEnabled
Boolean cWEMonitorEnabled

 Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
 instance terminated, failed deployment, and others.
 


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”
 
 
 


autoConfigEnabled
Boolean autoConfigEnabled

 Indicates whether auto-configuration is turned on for this application.
 


discoveryType
String discoveryType

 The method used by Application Insights to onboard your resources.
 


attachMissingPermission
Boolean attachMissingPermission

 If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
 








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


resourceGroupName
String resourceGroupName

 The name of the resource group of the application to which the configuration event belongs.
 


accountId
String accountId

 The AWS account ID for the owner of the application to which the configuration event belongs.
 


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.
 


cWEMonitorEnabled
Boolean cWEMonitorEnabled

 Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
 instance terminated, failed deployment, and others.
 


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.
 


autoConfigEnabled
Boolean autoConfigEnabled

 Indicates whether Application Insights automatically configures unmonitored resources in the resource group.
 


autoCreate
Boolean autoCreate

 Configures all of the resources in the resource group by applying the recommended configurations.
 


groupingType
String groupingType

 Application Insights can create applications based on a resource group or on an account. To create an
 account-based application using all of the resources in the account, set this parameter to
 ACCOUNT_BASED.
 


attachMissingPermission
Boolean attachMissingPermission

 If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
 








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. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference
 constructions are not supported.
 


rank
Integer rank

 Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are
 sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of
 rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will
 be last to get matched. When you configure custom log patterns from the console, a Low severity
 pattern translates to a 750,000 rank. A Medium severity pattern translates to a
 500,000 rank. And a High severity pattern translates to a 250,000 rank.
 Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided
 patterns.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


workloadName
String workloadName

 The name of the workload.
 


recommendationType
String recommendationType

 The recommended configuration type.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








Class com.amazonaws.services.applicationinsights.model.DescribeLogPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 


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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the owner of the resource group affected by 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.DescribeWorkloadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


componentName
String componentName

 The name of the component.
 


workloadId
String workloadId

 The ID of the workload.
 


accountId
String accountId

 The AWS account ID for the workload owner.
 








Class com.amazonaws.services.applicationinsights.model.DescribeWorkloadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workloadId
String workloadId

 The ID of the workload.
 


workloadRemarks
String workloadRemarks

 If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
 


workloadConfiguration
WorkloadConfiguration workloadConfiguration

 The configuration settings of the workload. The value is the escaped JSON of the configuration.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








Class com.amazonaws.services.applicationinsights.model.ListLogPatternSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 


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.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








Class com.amazonaws.services.applicationinsights.model.ListLogPatternsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 


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


accountId
String accountId

 The AWS account ID for the resource group owner.
 


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.
 


componentName
String componentName

 The name of the component.
 


visibility
String visibility

 Specifies whether or not you can view the problem. If not specified, visible and ignored problems are returned.
 








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.
 


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


accountId
String accountId

 The AWS account ID for the resource group owner.
 








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.ListWorkloadsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


componentName
String componentName

 The name of the component.
 


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.
 


accountId
String accountId

 The AWS account ID of the owner of the workload.
 








Class com.amazonaws.services.applicationinsights.model.ListWorkloadsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workloadList
List<E> workloadList

 The list of workloads.
 


nextToken
String nextToken

 The token to request the next page of results.
 








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 contain as 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 contain as 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 contain as many as 50 characters, and it
 cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference
 constructions are not supported.
 


rank
Integer rank

 Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are
 sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of
 rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will
 be last to get matched. When you configure custom log patterns from the console, a Low severity
 pattern translates to a 750,000 rank. A Medium severity pattern translates to a
 500,000 rank. And a High severity pattern translates to a 250,000 rank.
 Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided
 patterns.
 








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.
 


cloudWatchEventId
String cloudWatchEventId

 The ID of the CloudWatch Event-based observation related to the detected problem.
 


cloudWatchEventSource
String cloudWatchEventSource

 The source of the CloudWatch Event.
 


cloudWatchEventDetailType
String cloudWatchEventDetailType

 The detail type of the CloudWatch Event-based observation, for example,
 EC2 Instance State-change Notification.
 


healthEventArn
String healthEventArn

 The Amazon Resource Name (ARN) of the AWS Health Event-based observation.
 


healthService
String healthService

 The service to which the AWS Health Event belongs, such as EC2.
 


healthEventTypeCode
String healthEventTypeCode

 The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.
 


healthEventTypeCategory
String healthEventTypeCategory

 The category of the AWS Health event, such as issue.
 


healthEventDescription
String healthEventDescription

 The description of the AWS Health event provided by the service, such as Amazon EC2.
 


codeDeployDeploymentId
String codeDeployDeploymentId

 The deployment ID of the CodeDeploy-based observation related to the detected problem.
 


codeDeployDeploymentGroup
String codeDeployDeploymentGroup

 The deployment group to which the CodeDeploy deployment belongs.
 


codeDeployState
String codeDeployState

 The status of the CodeDeploy deployment, for example SUCCESS or  FAILURE.
 


codeDeployApplication
String codeDeployApplication

 The CodeDeploy application to which the deployment belongs.
 


codeDeployInstanceGroupId
String codeDeployInstanceGroupId

 The instance group to which the CodeDeploy instance belongs.
 


ec2State
String ec2State

 The state of the instance, such as STOPPING or TERMINATING.
 


rdsEventCategories
String rdsEventCategories

 The category of an RDS event.
 


rdsEventMessage
String rdsEventMessage

 The message of an RDS event.
 


s3EventName
String s3EventName

 The name of the S3 CloudWatch Event-based observation.
 


statesExecutionArn
String statesExecutionArn

 The Amazon Resource Name (ARN) of the step function execution-based observation.
 


statesArn
String statesArn

 The Amazon Resource Name (ARN) of the step function-based observation.
 


statesStatus
String statesStatus

 The status of the step function-related observation.
 


statesInput
String statesInput

 The input to the step function-based observation.
 


ebsEvent
String ebsEvent

 The type of EBS CloudWatch event, such as createVolume, deleteVolume or
 attachVolume.
 


ebsResult
String ebsResult

 The result of an EBS CloudWatch event, such as failed or succeeded.
 


ebsCause
String ebsCause

 The cause of an EBS CloudWatch event.
 


ebsRequestId
String ebsRequestId

 The request ID of an EBS CloudWatch event.
 


xRayFaultPercent
Integer xRayFaultPercent

 The X-Ray request fault percentage for this node.
 


xRayThrottlePercent
Integer xRayThrottlePercent

 The X-Ray request throttle percentage for this node.
 


xRayErrorPercent
Integer xRayErrorPercent

 The X-Ray request error percentage for this node.
 


xRayRequestCount
Integer xRayRequestCount

 The X-Ray request count for this node.
 


xRayRequestAverageLatency
Long xRayRequestAverageLatency

 The X-Ray node request average latency for this node.
 


xRayNodeName
String xRayNodeName

 The name of the X-Ray node.
 


xRayNodeType
String xRayNodeType

 The type of the X-Ray node.
 








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.
 


accountId
String accountId

 The AWS account ID for the owner of the resource group affected by 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.
 


recurringCount
Long recurringCount

 The number of times that the same problem reoccurred after the first time it was resolved.
 


lastRecurrenceTime
Date lastRecurrenceTime

 The last time that the problem reoccurred after its last resolution.
 


visibility
String visibility

 Specifies whether or not you can view the problem. Updates to ignored problems do not generate notifications.
 


resolutionMethod
String resolutionMethod

 Specifies how the problem was resolved. If the value is AUTOMATIC, the system resolved the problem.
 If the value is MANUAL, the user resolved the problem. If the value is UNRESOLVED, then
 the problem is not resolved.
 








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.RemoveWorkloadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


componentName
String componentName

 The name of the component.
 


workloadId
String workloadId

 The ID of the workload.
 








Class com.amazonaws.services.applicationinsights.model.RemoveWorkloadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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.
 


cWEMonitorEnabled
Boolean cWEMonitorEnabled

 Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as
 instance terminated, failed deployment, and others.
 


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.
 


autoConfigEnabled
Boolean autoConfigEnabled

 Turns auto-configuration on or off.
 


attachMissingPermission
Boolean attachMissingPermission

 If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing.
 








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.
 


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.
 


autoConfigEnabled
Boolean autoConfigEnabled

 Automatically configures the component by applying the recommended configurations.
 








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. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference
 constructions are not supported.
 


rank
Integer rank

 Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are
 sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of
 rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will
 be last to get matched. When you configure custom log patterns from the console, a Low severity
 pattern translates to a 750,000 rank. A Medium severity pattern translates to a
 500,000 rank. And a High severity pattern translates to a 250,000 rank.
 Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided
 patterns.
 








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.UpdateProblemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


problemId
String problemId

 The ID of the problem.
 


updateStatus
String updateStatus

 The status of the problem. Arguments can be passed for only problems that show a status of
 RECOVERING.
 


visibility
String visibility

 The visibility of a problem. When you pass a value of IGNORED, the problem is removed from the
 default view, and all notifications for the problem are suspended. When VISIBLE is passed, the
 IGNORED action is reversed.
 








Class com.amazonaws.services.applicationinsights.model.UpdateProblemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationinsights.model.UpdateWorkloadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupName
String resourceGroupName

 The name of the resource group.
 


componentName
String componentName

 The name of the component.
 


workloadId
String workloadId

 The ID of the workload.
 


workloadConfiguration
WorkloadConfiguration workloadConfiguration

 The configuration settings of the workload. The value is the escaped JSON of the configuration.
 








Class com.amazonaws.services.applicationinsights.model.UpdateWorkloadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workloadId
String workloadId

 The ID of the workload.
 


workloadConfiguration
WorkloadConfiguration workloadConfiguration

 The configuration settings of the workload. The value is the escaped JSON of the configuration.
 








Class com.amazonaws.services.applicationinsights.model.ValidationException extends AmazonApplicationInsightsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationinsights.model.Workload extends Object implements Serializable


Serialized Fields


workloadId
String workloadId

 The ID of the workload.
 


componentName
String componentName

 The name of the component.
 


workloadName
String workloadName

 The name of the workload.
 


tier
String tier

 The tier of the workload.
 


workloadRemarks
String workloadRemarks

 If logging is supported for the resource type, shows whether the component has configured logs to be monitored.
 








Class com.amazonaws.services.applicationinsights.model.WorkloadConfiguration extends Object implements Serializable


Serialized Fields


workloadName
String workloadName

 The name of the workload.
 


tier
String tier

 The configuration of the workload tier.
 


configuration
String configuration

 The configuration settings of the workload.
 








Package com.amazonaws.services.applicationsignals.model




Class com.amazonaws.services.applicationsignals.model.AccessDeniedException extends AmazonApplicationSignalsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationsignals.model.AmazonApplicationSignalsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationsignals.model.BatchGetServiceLevelObjectiveBudgetReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timestamp
Date timestamp

 The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1,
 1970 00:00:00 UTC.
 


sloIds
List<E> sloIds

 An array containing the IDs of the service level objectives that you want to include in the report.
 








Class com.amazonaws.services.applicationsignals.model.BatchGetServiceLevelObjectiveBudgetReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


timestamp
Date timestamp

 The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970
 00:00:00 UTC.
 


reports
List<E> reports

 An array of structures, where each structure is one budget report.
 


errors
List<E> errors

 An array of structures, where each structure includes an error indicating that one of the requests in the array
 was not valid.
 








Class com.amazonaws.services.applicationsignals.model.CalendarInterval extends Object implements Serializable


Serialized Fields


startTime
Date startTime

 The date and time when you want the first interval to start. Be sure to choose a time that configures the
 intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure
 to specify a start time that is a Monday at 6 a.m.
 
 
 When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
 1698778057
 
 
 As soon as one calendar interval ends, another automatically begins.
 


durationUnit
String durationUnit

 Specifies the calendar interval unit.
 


duration
Integer duration

 Specifies the duration of each calendar interval. For example, if Duration is 1 and
 DurationUnit is MONTH, each interval is one month, aligned with the calendar.
 








Class com.amazonaws.services.applicationsignals.model.ConflictException extends AmazonApplicationSignalsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationsignals.model.CreateServiceLevelObjectiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A name for this SLO.
 


description
String description

 An optional description for this SLO.
 


sliConfig
ServiceLevelIndicatorConfig sliConfig

 A structure that contains information about what service and what performance metric that this SLO will monitor.
 


goal
Goal goal

 A structure that contains the attributes that determine the goal of the SLO. This includes the time period for
 evaluation and the attainment threshold.
 


tags
List<E> tags

 A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able
 to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource
 permission.
 
 
 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.
 








Class com.amazonaws.services.applicationsignals.model.CreateServiceLevelObjectiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slo
ServiceLevelObjective slo

 A structure that contains information about the SLO that you just created.
 








Class com.amazonaws.services.applicationsignals.model.DeleteServiceLevelObjectiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ARN or name of the service level objective to delete.
 








Class com.amazonaws.services.applicationsignals.model.DeleteServiceLevelObjectiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationsignals.model.Dimension extends Object implements Serializable


Serialized Fields


name
String name

 The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
 non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
 supported as part of dimension names.
 


value
String value

 The value of the dimension. Dimension values must contain only ASCII characters and must include at least one
 non-whitespace character. ASCII control characters are not supported as part of dimension values.
 








Class com.amazonaws.services.applicationsignals.model.GetServiceLevelObjectiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using
 the ListServiceLevelObjectives operation.
 








Class com.amazonaws.services.applicationsignals.model.GetServiceLevelObjectiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slo
ServiceLevelObjective slo

 A structure containing the information about the SLO.
 








Class com.amazonaws.services.applicationsignals.model.GetServiceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


keyAttributes
Map<K,V> keyAttributes

 Use this field to specify which service you want to retrieve information for. You must specify at least the
 Type, Name, and Environment attributes.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 








Class com.amazonaws.services.applicationsignals.model.GetServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A structure containing information about the service.
 


startTime
Date startTime

 The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in
 seconds. For example: 1698778057.
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


endTime
Date endTime

 The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in
 seconds. For example: 1698778057.
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


logGroupReferences
List<E> logGroupReferences

 An array of string-to-string maps that each contain information about one log group associated with this service.
 Each string-to-string map includes the following fields:
 
 
 
 
 "Type": "AWS::Resource"
 
 
 
 
 "ResourceType": "AWS::Logs::LogGroup"
 
 
 
 
 "Identifier": "name-of-log-group"
 
 
 








Class com.amazonaws.services.applicationsignals.model.Goal extends Object implements Serializable


Serialized Fields


interval
Interval interval

 The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
 
 
 If you omit this parameter, a rolling interval of 7 days is used.
 


attainmentGoal
Double attainmentGoal

 The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods
 that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of
 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
 
 
 If you omit this parameter, 99 is used to represent 99% as the attainment goal.
 


warningThreshold
Double warningThreshold

 The percentage of remaining budget over total budget that you want to get warnings for. If you omit this
 parameter, the default of 50.0 is used.
 








Class com.amazonaws.services.applicationsignals.model.Interval extends Object implements Serializable


Serialized Fields


rollingInterval
RollingInterval rollingInterval

 If the interval is a rolling interval, this structure contains the interval specifications.
 


calendarInterval
CalendarInterval calendarInterval

 If the interval is a calendar interval, this structure contains the interval specifications.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceDependenciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested end time will be rounded to the nearest hour.
 


keyAttributes
Map<K,V> keyAttributes

 Use this field to specify which service you want to retrieve information for. You must specify at least the
 Type, Name, and Environment attributes.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous operation, to get the next set of service dependencies.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceDependenciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


serviceDependencies
List<E> serviceDependencies

 An array, where each object in the array contains information about one of the dependencies of this service.
 


nextToken
String nextToken

 Include this value in your next use of this API to get next set of service dependencies.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceDependentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


keyAttributes
Map<K,V> keyAttributes

 Use this field to specify which service you want to retrieve information for. You must specify at least the
 Type, Name, and Environment attributes.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous operation, to get the next set of service dependents.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceDependentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


serviceDependents
List<E> serviceDependents

 An array, where each object in the array contains information about one of the dependents of this service.
 


nextToken
String nextToken

 Include this value in your next use of this API to get next set of service dependents.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceLevelObjectivesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyAttributes
Map<K,V> keyAttributes

 You can use this optional field to specify which services you want to retrieve SLO information for.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


operationName
String operationName

 The name of the operation that this SLO is associated with.
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous operation, to get the next set of service level
 objectives.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceLevelObjectivesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sloSummaries
List<E> sloSummaries

 An array of structures, where each structure contains information about one SLO.
 


nextToken
String nextToken

 Include this value in your next use of this API to get next set of service level objectives.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested end time will be rounded to the nearest hour.
 


keyAttributes
Map<K,V> keyAttributes

 Use this field to specify which service you want to retrieve information for. You must specify at least the
 Type, Name, and Environment attributes.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous operation, to get the next set of service operations.
 








Class com.amazonaws.services.applicationsignals.model.ListServiceOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


serviceOperations
List<E> serviceOperations

 An array of structures that each contain information about one operation of this service.
 


nextToken
String nextToken

 Include this value in your next use of this API to get next set of service operations.
 








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


Serialized Fields


startTime
Date startTime

 The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
 be epoch time in seconds. For example: 1698778057
 
 
 Your requested start time will be rounded to the nearest hour.
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous operation, to get the next set of services.
 








Class com.amazonaws.services.applicationsignals.model.ListServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


startTime
Date startTime

 The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


endTime
Date endTime

 The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is
 formatted as be epoch time in seconds. For example: 1698778057
 
 
 This displays the time that Application Signals used for the request. It might not match your request exactly,
 because it was rounded to the nearest hour.
 


serviceSummaries
List<E> serviceSummaries

 An array of structures, where each structure contains some information about a service. To get complete
 information about a service, use GetService.
 


nextToken
String nextToken

 Include this value in your next use of this API to get next set of services.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.
 
 
 The ARN format of an Application Signals SLO is
 arn:aws:cloudwatch:Region:account-id:slo:slo-name 
 
 
 For more information about ARN format, see  Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
 








Class com.amazonaws.services.applicationsignals.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tag keys and values associated with the resource you specified.
 








Class com.amazonaws.services.applicationsignals.model.Metric extends Object implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric. For more information, see Namespaces.
 


metricName
String metricName

 The name of the metric to use.
 


dimensions
List<E> dimensions

 An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions
 .
 








Class com.amazonaws.services.applicationsignals.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 Id must be unique within a
 MetricDataQueries array. If you are performing math expressions on this set of data, this name
 represents that data and can serve as a variable in the metric math expression. The valid characters are letters,
 numbers, and underscore. The first character must be a lowercase letter.
 


metricStat
MetricStat metricStat

 A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
 
 
 Within one MetricDataQuery object, you must specify either Expression or
 MetricStat but not both.
 


expression
String expression

 This field can contain a metric math expression to be performed on the other metrics that you are retrieving
 within this MetricDataQueries structure.
 
 
 A math expression can use the Id of the other metrics or queries 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.
 
 
 You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic
 Labels.
 


returnData
Boolean returnData

 Use this only if you are using a metric math expression for the SLO. Specify true for
 ReturnData for only the one expression result to use as the alarm. For all other metrics and
 expressions in the same CreateServiceLevelObjective operation, specify ReturnData as
 false.
 


period
Integer period

 The granularity, in seconds, of the returned data points for this metric. 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).
 
 
 


accountId
String accountId

 The ID of the account where this metric is located. If you are performing this operatiion in a monitoring
 account, use this to specify which source account to retrieve this metric from.
 








Class com.amazonaws.services.applicationsignals.model.MetricReference extends Object implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric. For more information, see CloudWatchNamespaces.
 


metricType
String metricType

 Used to display the appropriate statistics in the CloudWatch console.
 


dimensions
List<E> dimensions

 An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
 


metricName
String metricName

 The name of the metric.
 








Class com.amazonaws.services.applicationsignals.model.MetricStat extends Object implements Serializable


Serialized Fields


metric
Metric metric

 The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
 


period
Integer period

 The granularity, in seconds, to be used for the metric. 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.
 


stat
String stat

 The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.
 For more information about statistics, see CloudWatch
 statistics definitions.
 


unit
String unit

 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 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.applicationsignals.model.ResourceNotFoundException extends AmazonApplicationSignalsException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceType
String resourceType

 The resource type is not valid.
 


resourceId
String resourceId

 Can't find the resource id.
 








Class com.amazonaws.services.applicationsignals.model.RollingInterval extends Object implements Serializable


Serialized Fields


durationUnit
String durationUnit

 Specifies the rolling interval unit.
 


duration
Integer duration

 Specifies the duration of each rolling interval. For example, if Duration is 7 and
 DurationUnit is DAY, each rolling interval is seven days.
 








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


Serialized Fields


keyAttributes
Map<K,V> keyAttributes

 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


attributeMaps
List<E> attributeMaps

 This structure contains one or more string-to-string maps that help identify this service. It can include
 platform attributes, application attributes, and telemetry attributes.
 
 
 Platform attributes contain information the service's platform.
 
 
 
 
 PlatformType defines the hosted-in platform.
 
 
 
 
 EKS.Cluster is the name of the Amazon EKS cluster.
 
 
 
 
 K8s.Cluster is the name of the self-hosted Kubernetes cluster.
 
 
 
 
 K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
 
 
 
 
 EC2.InstanceId is the ID of the Amazon EC2 instance.
 
 
 
 
 Host is the name of the host, for all platform types.
 
 
 
 
 Applciation attributes contain information about the application.
 
 
 
 
 AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
 
 
 
 
 AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
 
 
 
 
 Telemetry attributes contain telemetry information.
 
 
 
 
 Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
 
 
 
 
 Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
 
 
 
 
 Telemetry.Source Specifies the point of application where the telemetry was collected or specifies
 what was used for the source of telemetry data.
 
 
 


metricReferences
List<E> metricReferences

 An array of structures that each contain information about one metric associated with this service.
 


logGroupReferences
List<E> logGroupReferences

 An array of string-to-string maps that each contain information about one log group associated with this service.
 Each string-to-string map includes the following fields:
 
 
 
 
 "Type": "AWS::Resource"
 
 
 
 
 "ResourceType": "AWS::Logs::LogGroup"
 
 
 
 
 "Identifier": "name-of-log-group"
 
 
 








Class com.amazonaws.services.applicationsignals.model.ServiceDependency extends Object implements Serializable


Serialized Fields


operationName
String operationName

 The name of the operation in this service that calls the dependency.
 


dependencyKeyAttributes
Map<K,V> dependencyKeyAttributes

 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


dependencyOperationName
String dependencyOperationName

 The name of the called operation in the dependency.
 


metricReferences
List<E> metricReferences

 An array of structures that each contain information about one metric associated with this service dependency
 that was discovered by Application Signals.
 








Class com.amazonaws.services.applicationsignals.model.ServiceDependent extends Object implements Serializable


Serialized Fields


operationName
String operationName

 If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
 


dependentKeyAttributes
Map<K,V> dependentKeyAttributes

 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


dependentOperationName
String dependentOperationName

 If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is
 displayed here.
 


metricReferences
List<E> metricReferences

 An array of structures that each contain information about one metric associated with this service dependent that
 was discovered by Application Signals.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelIndicator extends Object implements Serializable


Serialized Fields


sliMetric
ServiceLevelIndicatorMetric sliMetric

 A structure that contains information about the metric that the SLO monitors.
 


metricThreshold
Double metricThreshold

 The value that the SLI metric is compared to.
 


comparisonOperator
String comparisonOperator

 The arithmetic operation used when comparing the specified metric to the threshold.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelIndicatorConfig extends Object implements Serializable


Serialized Fields


sliMetricConfig
ServiceLevelIndicatorMetricConfig sliMetricConfig

 Use this structure to specify the metric to be used for the SLO.
 


metricThreshold
Double metricThreshold

 The value that the SLI metric is compared to.
 


comparisonOperator
String comparisonOperator

 The arithmetic operation to use when comparing the specified metric to the threshold.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelIndicatorMetric extends Object implements Serializable


Serialized Fields


keyAttributes
Map<K,V> keyAttributes

 This is a string-to-string map that contains information about the type of object that this SLO is related to. It
 can include the following fields.
 
 
 
 
 Type designates the type of object that this SLO is related to.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


operationName
String operationName

 If the SLO monitors a specific operation of the service, this field displays that operation name.
 


metricType
String metricType

 If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals
 collects, this field displays which of those metrics is used.
 


metricDataQueries
List<E> metricDataQueries

 If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure
 includes the information about that metric or expression.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelIndicatorMetricConfig extends Object implements Serializable


Serialized Fields


keyAttributes
Map<K,V> keyAttributes

 If this SLO is related to a metric collected by Application Signals, you must use this field to specify which
 service the SLO metric is related to. To do so, you must specify at least the Type,
 Name, and Environment attributes.
 
 
 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


operationName
String operationName

 If the SLO is to monitor a specific operation of the service, use this field to specify the name of that
 operation.
 


metricType
String metricType

 If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application
 Signals collects, use this field to specify which of those metrics is used.
 


statistic
String statistic

 The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.
 For more information about statistics, see CloudWatch
 statistics definitions.
 


periodSeconds
Integer periodSeconds

 The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the
 SLI during each period. For each period, the application is determined to have either achieved or not achieved
 the necessary performance.
 


metricDataQueries
List<E> metricDataQueries

 If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure
 to specify that metric or expression.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelObjective extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of this SLO.
 


name
String name

 The name of this SLO.
 


description
String description

 The description that you created for this SLO.
 


createdTime
Date createdTime

 The date and time that this SLO was created. 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.
 


lastUpdatedTime
Date lastUpdatedTime

 The time that this SLO was most recently updated. 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.
 


sli
ServiceLevelIndicator sli

 A structure containing information about the performance metric that this SLO monitors.
 


goal
Goal goal








Class com.amazonaws.services.applicationsignals.model.ServiceLevelObjectiveBudgetReport extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the SLO that this report is for.
 


name
String name

 The name of the SLO that this report is for.
 


budgetStatus
String budgetStatus

 The status of this SLO, as it relates to the error budget for the entire time interval.
 
 
 
 
 OK means that the SLO had remaining budget above the warning threshold, as of the time that you
 specified in TimeStamp.
 
 
 
 
 WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that
 you specified in TimeStamp.
 
 
 
 
 BREACHED means that the SLO's budget was exhausted, as of the time that you specified in
 TimeStamp.
 
 
 
 
 INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or
 that attainment data is missing.
 
 
 


attainment
Double attainment

 A number between 0 and 100 that represents the percentage of time periods that the service has attained the SLO's
 attainment goal, as of the time of the request.
 


totalBudgetSeconds
Integer totalBudgetSeconds

 The total number of seconds in the error budget for the interval.
 


budgetSecondsRemaining
Integer budgetSecondsRemaining

 The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the
 Timestemp parameter of the request. If this value is negative, then the SLO is already in
 BREACHING status.
 


sli
ServiceLevelIndicator sli

 A structure that contains information about the performance metric that this SLO monitors.
 


goal
Goal goal








Class com.amazonaws.services.applicationsignals.model.ServiceLevelObjectiveBudgetReportError extends Object implements Serializable


Serialized Fields


name
String name

 The name of the SLO that this error is related to.
 


arn
String arn

 The ARN of the SLO that this error is related to.
 


errorCode
String errorCode

 The error code for this error.
 


errorMessage
String errorMessage

 The message for this error.
 








Class com.amazonaws.services.applicationsignals.model.ServiceLevelObjectiveSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of this service level objective.
 


name
String name

 The name of the service level objective.
 


keyAttributes
Map<K,V> keyAttributes

 This is a string-to-string map. It can include the following fields.
 
 
 
 
 Type designates the type of object this service level objective is for.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


operationName
String operationName

 If this service level objective is specific to a single operation, this field displays the name of that
 operation.
 


createdTime
Date createdTime

 The date and time that this service level objective was created. It is expressed as the number of milliseconds
 since Jan 1, 1970 00:00:00 UTC.
 








Class com.amazonaws.services.applicationsignals.model.ServiceOperation extends Object implements Serializable


Serialized Fields


name
String name

 The name of the operation, discovered by Application Signals.
 


metricReferences
List<E> metricReferences

 An array of structures that each contain information about one metric associated with this service operation that
 was discovered by Application Signals.
 








Class com.amazonaws.services.applicationsignals.model.ServiceQuotaExceededException extends AmazonApplicationSignalsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationsignals.model.ServiceSummary extends Object implements Serializable


Serialized Fields


keyAttributes
Map<K,V> keyAttributes

 This is a string-to-string map that help identify the objects discovered by Application Signals. It can include
 the following fields.
 
 
 
 
 Type designates the type of object this is.
 
 
 
 
 ResourceType specifies the type of the resource. This field is used only when the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Name specifies the name of the object. This is used only if the value of the Type field
 is Service, RemoteService, or AWS::Service.
 
 
 
 
 Identifier identifies the resource objects of this resource. This is used only if the value of the
 Type field is Resource or AWS::Resource.
 
 
 
 
 Environment specifies the location where this object is hosted, or what it belongs to.
 
 
 


attributeMaps
List<E> attributeMaps

 This structure contains one or more string-to-string maps that help identify this service. It can include
 platform attributes, application attributes, and telemetry attributes.
 
 
 Platform attributes contain information the service's platform.
 
 
 
 
 PlatformType defines the hosted-in platform.
 
 
 
 
 EKS.Cluster is the name of the Amazon EKS cluster.
 
 
 
 
 K8s.Cluster is the name of the self-hosted Kubernetes cluster.
 
 
 
 
 K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
 
 
 
 
 EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
 
 
 
 
 EC2.InstanceId is the ID of the Amazon EC2 instance.
 
 
 
 
 Host is the name of the host, for all platform types.
 
 
 
 
 Applciation attributes contain information about the application.
 
 
 
 
 AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
 
 
 
 
 AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
 
 
 
 
 Telemetry attributes contain telemetry information.
 
 
 
 
 Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
 
 
 
 
 Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
 
 
 
 
 Telemetry.Source Specifies the point of application where the telemetry was collected or specifies
 what was used for the source of telemetry data.
 
 
 


metricReferences
List<E> metricReferences

 An array of structures that each contain information about one metric associated with this service.
 








Class com.amazonaws.services.applicationsignals.model.StartDiscoveryRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.applicationsignals.model.StartDiscoveryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationsignals.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.applicationsignals.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.
 
 
 The ARN format of an Application Signals SLO is
 arn:aws:cloudwatch:Region:account-id:slo:slo-name 
 
 
 For more information about ARN format, see  Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
 


tags
List<E> tags

 The list of key-value pairs to associate with the alarm.
 








Class com.amazonaws.services.applicationsignals.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationsignals.model.ThrottlingException extends AmazonApplicationSignalsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.applicationsignals.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.
 
 
 The ARN format of an Application Signals SLO is
 arn:aws:cloudwatch:Region:account-id:slo:slo-name 
 
 
 For more information about ARN format, see  Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
 


tagKeys
List<E> tagKeys

 The list of tag keys to remove from the resource.
 








Class com.amazonaws.services.applicationsignals.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.applicationsignals.model.UpdateServiceLevelObjectiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The Amazon Resource Name (ARN) or name of the service level objective that you want to update.
 


description
String description

 An optional description for the SLO.
 


sliConfig
ServiceLevelIndicatorConfig sliConfig

 A structure that contains information about what performance metric this SLO will monitor.
 


goal
Goal goal

 A structure that contains the attributes that determine the goal of the SLO. This includes the time period for
 evaluation and the attainment threshold.
 








Class com.amazonaws.services.applicationsignals.model.UpdateServiceLevelObjectiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slo
ServiceLevelObjective slo

 A structure that contains information about the SLO that you just updated.
 








Class com.amazonaws.services.applicationsignals.model.ValidationException extends AmazonApplicationSignalsException 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 Cloud Map service instance attribute key. Any Cloud Map service instance that contains the
 specified key and value is returned.
 


value
String value

 The value of an Cloud Map service instance attribute key. Any 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.
 


ipPreference
String ipPreference

 The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only
 overrides the IP preference set for the mesh on this specific node.
 


namespaceName
String namespaceName

 The name of the Cloud Map namespace to use.
 


serviceName
String serviceName

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








Class com.amazonaws.services.appmesh.model.BackendDefaults extends Object implements Serializable


Serialized Fields


clientPolicy
ClientPolicy clientPolicy

 A reference to an object that represents a client policy.
 








Class com.amazonaws.services.appmesh.model.BadRequestException extends AWSAppMeshException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appmesh.model.ClientPolicy extends Object implements Serializable


Serialized Fields


tls
ClientPolicyTls tls

 A reference to an object that represents a Transport Layer Security (TLS) client policy.
 








Class com.amazonaws.services.appmesh.model.ClientPolicyTls extends Object implements Serializable


Serialized Fields


certificate
ClientTlsCertificate certificate

 A reference to an object that represents a client's TLS certificate.
 


enforce
Boolean enforce

 Whether the policy is enforced. The default is True, if a value isn't specified.
 


ports
List<E> ports

 One or more ports that the policy is enforced for.
 


validation
TlsValidationContext validation

 A reference to an object that represents a TLS validation context.
 








Class com.amazonaws.services.appmesh.model.ClientTlsCertificate extends Object implements Serializable


Serialized Fields


file
ListenerTlsFileCertificate file

 An object that represents a local file certificate. The certificate must meet specific requirements and you must
 have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
 


sds
ListenerTlsSdsCertificate sds

 A reference to an object that represents a client's TLS Secret Discovery Service certificate.
 








Class com.amazonaws.services.appmesh.model.ConflictException extends AWSAppMeshException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appmesh.model.CreateGatewayRouteRequest 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.
 


gatewayRouteName
String gatewayRouteName

 The name to use for the gateway route.
 


meshName
String meshName

 The name of the service mesh to create the gateway route in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


spec
GatewayRouteSpec spec

 The gateway route specification to apply.
 


tags
List<E> tags

 Optional metadata that you can apply to the gateway 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.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh,
 then you must be the owner of the virtual gateway resource.
 








Class com.amazonaws.services.appmesh.model.CreateGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gatewayRoute
GatewayRouteData gatewayRoute

 The full description of your gateway route following the create call.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


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. If the virtual router is in a shared mesh, then you
 must be the owner of the virtual router resource.
 








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.CreateVirtualGatewayRequest 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 gateway in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


spec
VirtualGatewaySpec spec

 The virtual gateway specification to apply.
 


tags
List<E> tags

 Optional metadata that you can apply to the virtual gateway 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.
 


virtualGatewayName
String virtualGatewayName

 The name to use for the virtual gateway.
 








Class com.amazonaws.services.appmesh.model.CreateVirtualGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualGateway
VirtualGatewayData virtualGateway

 The full description of your virtual gateway 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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the
 account that you specify must share the mesh with your account before you can create the resource in the service
 mesh. For more information about mesh sharing, see Working with shared meshes.
 


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.DeleteGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gatewayRouteName
String gatewayRouteName

 The name of the gateway route to delete.
 


meshName
String meshName

 The name of the service mesh to delete the gateway route from.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to delete the route from.
 








Class com.amazonaws.services.appmesh.model.DeleteGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gatewayRoute
GatewayRouteData gatewayRoute

 The gateway route that was deleted.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.DeleteVirtualGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meshName
String meshName

 The name of the service mesh to delete the virtual gateway from.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to delete.
 








Class com.amazonaws.services.appmesh.model.DeleteVirtualGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualGateway
VirtualGatewayData virtualGateway

 The virtual gateway 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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.DescribeGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gatewayRouteName
String gatewayRouteName

 The name of the gateway route to describe.
 


meshName
String meshName

 The name of the service mesh that the gateway route resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway that the gateway route is associated with.
 








Class com.amazonaws.services.appmesh.model.DescribeGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gatewayRoute
GatewayRouteData gatewayRoute

 The full description of your gateway route.
 








Class com.amazonaws.services.appmesh.model.DescribeMeshRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meshName
String meshName

 The name of the service mesh to describe.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.DescribeVirtualGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meshName
String meshName

 The name of the service mesh that the gateway route resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to describe.
 








Class com.amazonaws.services.appmesh.model.DescribeVirtualGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualGateway
VirtualGatewayData virtualGateway

 The full description of your virtual gateway.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


ipPreference
String ipPreference

 The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only
 overrides the IP preference set for the mesh on this specific node.
 


responseType
String responseType

 Specifies the DNS response type 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 Amazon
 Web Services 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


format
LoggingFormat format

 The specified format for the logs. The format is either json_format or text_format.
 


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.GatewayRouteData extends Object implements Serializable


Serialized Fields


gatewayRouteName
String gatewayRouteName

 The name of the gateway route.
 


meshName
String meshName

 The name of the service mesh that the resource resides in.
 


metadata
ResourceMetadata metadata


spec
GatewayRouteSpec spec

 The specifications of the gateway route.
 


status
GatewayRouteStatus status

 The status of the gateway route.
 


virtualGatewayName
String virtualGatewayName

 The virtual gateway that the gateway route is associated with.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteHostnameMatch extends Object implements Serializable


Serialized Fields


exact
String exact

 The exact host name to match on.
 


suffix
String suffix

 The specified ending characters of the host name to match on.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteHostnameRewrite extends Object implements Serializable


Serialized Fields


defaultTargetHostname
String defaultTargetHostname

 The default target host name to write to.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteRef extends Object implements Serializable


Serialized Fields


arn
String arn

 The full Amazon Resource Name (ARN) for the gateway route.
 


createdAt
Date createdAt

 The Unix epoch timestamp in seconds for when the resource was created.
 


gatewayRouteName
String gatewayRouteName

 The name of the gateway route.
 


lastUpdatedAt
Date lastUpdatedAt

 The Unix epoch timestamp in seconds for when the resource was last updated.
 


meshName
String meshName

 The name of the service mesh that the resource resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


virtualGatewayName
String virtualGatewayName

 The virtual gateway that the gateway route is associated with.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteSpec extends Object implements Serializable


Serialized Fields


grpcRoute
GrpcGatewayRoute grpcRoute

 An object that represents the specification of a gRPC gateway route.
 


http2Route
HttpGatewayRoute http2Route

 An object that represents the specification of an HTTP/2 gateway route.
 


httpRoute
HttpGatewayRoute httpRoute

 An object that represents the specification of an HTTP gateway route.
 


priority
Integer priority

 The ordering of the gateway routes spec.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteStatus extends Object implements Serializable


Serialized Fields


status
String status

 The current status for the gateway route.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteTarget extends Object implements Serializable


Serialized Fields


port
Integer port

 The port number of the gateway route target.
 


virtualService
GatewayRouteVirtualService virtualService

 An object that represents a virtual service gateway route target.
 








Class com.amazonaws.services.appmesh.model.GatewayRouteVirtualService extends Object implements Serializable


Serialized Fields


virtualServiceName
String virtualServiceName

 The name of the virtual service that traffic is routed to.
 








Class com.amazonaws.services.appmesh.model.GrpcGatewayRoute extends Object implements Serializable


Serialized Fields


action
GrpcGatewayRouteAction action

 An object that represents the action to take if a match is determined.
 


match
GrpcGatewayRouteMatch match

 An object that represents the criteria for determining a request match.
 








Class com.amazonaws.services.appmesh.model.GrpcGatewayRouteAction extends Object implements Serializable


Serialized Fields


rewrite
GrpcGatewayRouteRewrite rewrite

 The gateway route action to rewrite.
 


target
GatewayRouteTarget target

 An object that represents the target that traffic is routed to when a request matches the gateway route.
 








Class com.amazonaws.services.appmesh.model.GrpcGatewayRouteMatch extends Object implements Serializable


Serialized Fields


hostname
GatewayRouteHostnameMatch hostname

 The gateway route host name to be matched on.
 


metadata
List<E> metadata

 The gateway route metadata to be matched on.
 


port
Integer port

 The gateway route port to be matched on.
 


serviceName
String serviceName

 The fully qualified domain name for the service to match from the request.
 








Class com.amazonaws.services.appmesh.model.GrpcGatewayRouteMetadata extends Object implements Serializable


Serialized Fields


invert
Boolean invert

 Specify True to match anything except the match criteria. The default value is False.
 


match
GrpcMetadataMatchMethod match

 The criteria for determining a metadata match.
 


name
String name

 A name for the gateway route metadata.
 








Class com.amazonaws.services.appmesh.model.GrpcGatewayRouteRewrite extends Object implements Serializable


Serialized Fields


hostname
GatewayRouteHostnameRewrite hostname

 The host name of the gateway route to rewrite.
 








Class com.amazonaws.services.appmesh.model.GrpcMetadataMatchMethod extends Object implements Serializable


Serialized Fields


exact
String exact

 The exact method header to be matched on.
 


prefix
String prefix

 The specified beginning characters of the method header to be matched on.
 


range
MatchRange range


regex
String regex

 The regex used to match the method header.
 


suffix
String suffix

 The specified ending characters of the method header to match on.
 








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

 The timeout for each retry attempt.
 


tcpRetryEvents
List<E> tcpRetryEvents

 Specify a valid value. The event occurs before any processing of a request has started and is encountered when
 the upstream is temporarily or permanently unavailable.
 








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.
 


timeout
GrpcTimeout timeout

 An object that represents types of timeouts.
 








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.
 


port
Integer port

 The port number to match on.
 


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.GrpcTimeout extends Object implements Serializable


Serialized Fields


idle
Duration idle

 An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
 idle. The default value is none.
 


perRequest
Duration perRequest

 An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout,
 then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a
 virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be
 greater than 15 seconds for the source and destination virtual node and the route.
 








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 value is only used if the specified protocol is HTTP or
 HTTP/2. For any other protocol, this value 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. If you specify grpc, then your service must conform to
 the GRPC Health Checking Protocol.
 


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.HttpGatewayRoute extends Object implements Serializable


Serialized Fields


action
HttpGatewayRouteAction action

 An object that represents the action to take if a match is determined.
 


match
HttpGatewayRouteMatch match

 An object that represents the criteria for determining a request match.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRouteAction extends Object implements Serializable


Serialized Fields


rewrite
HttpGatewayRouteRewrite rewrite

 The gateway route action to rewrite.
 


target
GatewayRouteTarget target

 An object that represents the target that traffic is routed to when a request matches the gateway route.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRouteHeader 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

 An object that represents the method and value to match with the header value sent in a request. Specify one
 match method.
 


name
String name

 A name for the HTTP header in the gateway route that will be matched on.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRouteMatch extends Object implements Serializable


Serialized Fields


headers
List<E> headers

 The client request headers to match on.
 


hostname
GatewayRouteHostnameMatch hostname

 The host name to match on.
 


method
String method

 The method to match on.
 


path
HttpPathMatch path

 The path to match on.
 


port
Integer port

 The port number to match on.
 


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.
 


queryParameters
List<E> queryParameters

 The query parameter to match on.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRoutePathRewrite extends Object implements Serializable


Serialized Fields


exact
String exact

 The exact path to rewrite.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRoutePrefixRewrite extends Object implements Serializable


Serialized Fields


defaultPrefix
String defaultPrefix

 The default prefix used to replace the incoming route prefix when rewritten.
 


value
String value

 The value used to replace the incoming route prefix when rewritten.
 








Class com.amazonaws.services.appmesh.model.HttpGatewayRouteRewrite extends Object implements Serializable


Serialized Fields


hostname
GatewayRouteHostnameRewrite hostname

 The host name to rewrite.
 


path
HttpGatewayRoutePathRewrite path

 The path to rewrite.
 


prefix
HttpGatewayRoutePrefixRewrite prefix

 The specified beginning characters to rewrite.
 








Class com.amazonaws.services.appmesh.model.HttpPathMatch extends Object implements Serializable


Serialized Fields


exact
String exact

 The exact path to match on.
 


regex
String regex

 The regex used to match the path.
 








Class com.amazonaws.services.appmesh.model.HttpQueryParameter extends Object implements Serializable


Serialized Fields


match
QueryParameterMatch match

 The query parameter to match on.
 


name
String name

 A name for the query parameter that will be matched on.
 








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

 The timeout for each retry attempt.
 


tcpRetryEvents
List<E> tcpRetryEvents

 Specify a valid value. The event occurs before any processing of a request has started and is encountered when
 the upstream is temporarily or permanently unavailable.
 








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.
 


timeout
HttpTimeout timeout

 An object that represents types of timeouts.
 








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

 The client request headers to match on.
 


method
String method

 The client request method to match on. Specify only one.
 


path
HttpPathMatch path

 The client request path to match on.
 


port
Integer port

 The port number to match on.
 


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.
 


queryParameters
List<E> queryParameters

 The client request query parameters to match on.
 


scheme
String scheme

 The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
 








Class com.amazonaws.services.appmesh.model.HttpTimeout extends Object implements Serializable


Serialized Fields


idle
Duration idle

 An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
 idle. The default value is none.
 


perRequest
Duration perRequest

 An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout,
 then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a
 virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be
 greater than 15 seconds for the source and destination virtual node and the route.
 








Class com.amazonaws.services.appmesh.model.InternalServerErrorException extends AWSAppMeshException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appmesh.model.JsonFormatRef extends Object implements Serializable


Serialized Fields


key
String key

 The specified key for the JSON.
 


value
String value

 The specified value for the JSON.
 








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


connectionPool
VirtualNodeConnectionPool connectionPool

 The connection pool information for the listener.
 


healthCheck
HealthCheckPolicy healthCheck

 The health check information for the listener.
 


outlierDetection
OutlierDetection outlierDetection

 The outlier detection information for the listener.
 


portMapping
PortMapping portMapping

 The port mapping information for the listener.
 


timeout
ListenerTimeout timeout

 An object that represents timeouts for different protocols.
 


tls
ListenerTls tls

 A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.
 








Class com.amazonaws.services.appmesh.model.ListenerTimeout extends Object implements Serializable


Serialized Fields


grpc
GrpcTimeout grpc

 An object that represents types of timeouts.
 


http
HttpTimeout http

 An object that represents types of timeouts.
 


http2
HttpTimeout http2

 An object that represents types of timeouts.
 


tcp
TcpTimeout tcp

 An object that represents types of timeouts.
 








Class com.amazonaws.services.appmesh.model.ListenerTls extends Object implements Serializable


Serialized Fields


certificate
ListenerTlsCertificate certificate

 A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.
 


mode
String mode

 Specify one of the following modes.
 
 
 
 
 STRICT – Listener only accepts connections with TLS enabled.
 

 

 
 
 PERMISSIVE – Listener accepts connections with or without TLS enabled.
 

 

 
 
 DISABLED – Listener only accepts connections without TLS.
 

 

 



validation
ListenerTlsValidationContext validation

 A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.
 








Class com.amazonaws.services.appmesh.model.ListenerTlsAcmCertificate extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must
 have proxy authorization enabled. For more information, see Transport
 Layer Security (TLS).
 








Class com.amazonaws.services.appmesh.model.ListenerTlsCertificate extends Object implements Serializable


Serialized Fields


acm
ListenerTlsAcmCertificate acm

 A reference to an object that represents an Certificate Manager certificate.
 


file
ListenerTlsFileCertificate file

 A reference to an object that represents a local file certificate.
 


sds
ListenerTlsSdsCertificate sds

 A reference to an object that represents a listener's Secret Discovery Service certificate.
 








Class com.amazonaws.services.appmesh.model.ListenerTlsFileCertificate extends Object implements Serializable


Serialized Fields


certificateChain
String certificateChain

 The certificate chain for the certificate.
 


privateKey
String privateKey

 The private key for a certificate stored on the file system of the virtual node that the proxy is running on.
 








Class com.amazonaws.services.appmesh.model.ListenerTlsSdsCertificate extends Object implements Serializable


Serialized Fields


secretName
String secretName

 A reference to an object that represents the name of the secret requested from the Secret Discovery Service
 provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
 








Class com.amazonaws.services.appmesh.model.ListenerTlsValidationContext extends Object implements Serializable


Serialized Fields


subjectAlternativeNames
SubjectAlternativeNames subjectAlternativeNames

 A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation
 context.
 


trust
ListenerTlsValidationContextTrust trust

 A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
 certificate.
 








Class com.amazonaws.services.appmesh.model.ListenerTlsValidationContextTrust extends Object implements Serializable


Serialized Fields


file
TlsValidationContextFileTrust file

 An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
 


sds
TlsValidationContextSdsTrust sds

 A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service
 validation context trust.
 








Class com.amazonaws.services.appmesh.model.ListGatewayRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this
 parameter, ListGatewayRoutes 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 ListGatewayRoutes request with the returned nextToken value. This value can be
 between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and
 a nextToken value if applicable.
 


meshName
String meshName

 The name of the service mesh to list gateway routes in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListGatewayRoutes 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.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to list gateway routes in.
 








Class com.amazonaws.services.appmesh.model.ListGatewayRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gatewayRoutes
List<E> gatewayRoutes

 The list of existing gateway routes for the specified service mesh and virtual gateway.
 


nextToken
String nextToken

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


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.ListVirtualGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of results returned by ListVirtualGateways in paginated output. When you use this
 parameter, ListVirtualGateways 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 ListVirtualGateways request with the returned nextToken value. This value can
 be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results
 and a nextToken value if applicable.
 


meshName
String meshName

 The name of the service mesh to list virtual gateways in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListVirtualGateways 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.ListVirtualGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

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


virtualGateways
List<E> virtualGateways

 The list of existing virtual gateways for the specified service mesh.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.LoggingFormat extends Object implements Serializable


Serialized Fields


json
List<E> json



text
String text









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.
 


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.
 


meshName
String meshName

 The name of the service mesh.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.MeshServiceDiscovery extends Object implements Serializable


Serialized Fields


ipPreference
String ipPreference

 The IP version to use to control traffic within the 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.
 


serviceDiscovery
MeshServiceDiscovery serviceDiscovery








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.OutlierDetection extends Object implements Serializable


Serialized Fields


baseEjectionDuration
Duration baseEjectionDuration

 The base amount of time for which a host is ejected.
 


interval
Duration interval

 The time interval between ejection sweep analysis.
 


maxEjectionPercent
Integer maxEjectionPercent

 Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least
 one host regardless of the value.
 


maxServerErrors
Long maxServerErrors

 Number of consecutive 5xx errors required for ejection.
 








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.QueryParameterMatch extends Object implements Serializable


Serialized Fields


exact
String exact

 The exact query parameter to match on.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


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.
 


meshName
String meshName

 The name of the service mesh that the route resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


routeName
String routeName

 The name of the route.
 


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.
 


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 HTTP/2 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 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.SubjectAlternativeNameMatchers extends Object implements Serializable


Serialized Fields


exact
List<E> exact

 The values sent must match the specified values exactly.
 








Class com.amazonaws.services.appmesh.model.SubjectAlternativeNames extends Object implements Serializable


Serialized Fields


match
SubjectAlternativeNameMatchers match

 An object that represents the criteria for determining a SANs match.
 








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.
 


match
TcpRouteMatch match

 An object that represents the criteria for determining a request match.
 


timeout
TcpTimeout timeout

 An object that represents types of timeouts.
 








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.TcpRouteMatch extends Object implements Serializable


Serialized Fields


port
Integer port

 The port number to match on.
 








Class com.amazonaws.services.appmesh.model.TcpTimeout extends Object implements Serializable


Serialized Fields


idle
Duration idle

 An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
 idle. The default value is none.
 








Class com.amazonaws.services.appmesh.model.TlsValidationContext extends Object implements Serializable


Serialized Fields


subjectAlternativeNames
SubjectAlternativeNames subjectAlternativeNames

 A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you
 don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN
 on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the
 certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration.
 Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the
 service discovery name.
 


trust
TlsValidationContextTrust trust

 A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
 certificate.
 








Class com.amazonaws.services.appmesh.model.TlsValidationContextAcmTrust extends Object implements Serializable


Serialized Fields


certificateAuthorityArns
List<E> certificateAuthorityArns

 One or more ACM Amazon Resource Name (ARN)s.
 








Class com.amazonaws.services.appmesh.model.TlsValidationContextFileTrust extends Object implements Serializable


Serialized Fields


certificateChain
String certificateChain

 The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is
 running on.
 








Class com.amazonaws.services.appmesh.model.TlsValidationContextSdsTrust extends Object implements Serializable


Serialized Fields


secretName
String secretName

 A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret
 Discovery Service validation context trust.
 








Class com.amazonaws.services.appmesh.model.TlsValidationContextTrust extends Object implements Serializable


Serialized Fields


acm
TlsValidationContextAcmTrust acm

 A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an
 Certificate Manager certificate.
 


file
TlsValidationContextFileTrust file

 An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
 


sds
TlsValidationContextSdsTrust sds

 A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation
 context trust.
 








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


gatewayRouteName
String gatewayRouteName

 The name of the gateway route to update.
 


meshName
String meshName

 The name of the service mesh that the gateway route resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


spec
GatewayRouteSpec spec

 The new gateway route specification to apply. This overwrites the existing data.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway that the gateway route is associated with.
 








Class com.amazonaws.services.appmesh.model.UpdateGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gatewayRoute
GatewayRouteData gatewayRoute

 A full description of the gateway route that was updated.
 








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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.UpdateVirtualGatewayRequest 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 gateway resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


spec
VirtualGatewaySpec spec

 The new virtual gateway specification to apply. This overwrites the existing data.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway to update.
 








Class com.amazonaws.services.appmesh.model.UpdateVirtualGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualGateway
VirtualGatewayData virtualGateway

 A full description of the virtual gateway 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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


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.VirtualGatewayAccessLog extends Object implements Serializable


Serialized Fields


file
VirtualGatewayFileAccessLog file

 The file object to send virtual gateway access logs to.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayBackendDefaults extends Object implements Serializable


Serialized Fields


clientPolicy
VirtualGatewayClientPolicy clientPolicy

 A reference to an object that represents a client policy.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayClientPolicy extends Object implements Serializable


Serialized Fields


tls
VirtualGatewayClientPolicyTls tls

 A reference to an object that represents a Transport Layer Security (TLS) client policy.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayClientPolicyTls extends Object implements Serializable


Serialized Fields


certificate
VirtualGatewayClientTlsCertificate certificate

 A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.
 


enforce
Boolean enforce

 Whether the policy is enforced. The default is True, if a value isn't specified.
 


ports
List<E> ports

 One or more ports that the policy is enforced for.
 


validation
VirtualGatewayTlsValidationContext validation

 A reference to an object that represents a Transport Layer Security (TLS) validation context.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayClientTlsCertificate extends Object implements Serializable


Serialized Fields


file
VirtualGatewayListenerTlsFileCertificate file

 An object that represents a local file certificate. The certificate must meet specific requirements and you must
 have proxy authorization enabled. For more information, see  Transport Layer Security (TLS) .
 


sds
VirtualGatewayListenerTlsSdsCertificate sds

 A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayConnectionPool extends Object implements Serializable


Serialized Fields


grpc
VirtualGatewayGrpcConnectionPool grpc

 An object that represents a type of connection pool.
 


http
VirtualGatewayHttpConnectionPool http

 An object that represents a type of connection pool.
 


http2
VirtualGatewayHttp2ConnectionPool http2

 An object that represents a type of connection pool.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayData extends Object implements Serializable


Serialized Fields


meshName
String meshName

 The name of the service mesh that the virtual gateway resides in.
 


metadata
ResourceMetadata metadata


spec
VirtualGatewaySpec spec

 The specifications of the virtual gateway.
 


status
VirtualGatewayStatus status

 The current status of the virtual gateway.
 


virtualGatewayName
String virtualGatewayName

 The name of the virtual gateway.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayFileAccessLog extends Object implements Serializable


Serialized Fields


format
LoggingFormat format

 The specified format for the virtual gateway access logs. It can be either json_format or
 text_format.
 


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.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayGrpcConnectionPool extends Object implements Serializable


Serialized Fields


maxRequests
Integer maxRequests

 Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayHealthCheckPolicy extends Object implements Serializable


Serialized Fields


healthyThreshold
Integer healthyThreshold

 The number of consecutive successful health checks that must occur before declaring the 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 value is only used if the specified protocol is HTTP or
 HTTP/2. For any other protocol, this value 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. If you specify grpc, then your service must conform to
 the GRPC Health Checking Protocol.
 


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








Class com.amazonaws.services.appmesh.model.VirtualGatewayHttp2ConnectionPool extends Object implements Serializable


Serialized Fields


maxRequests
Integer maxRequests

 Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayHttpConnectionPool extends Object implements Serializable


Serialized Fields


maxConnections
Integer maxConnections

 Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
 


maxPendingRequests
Integer maxPendingRequests

 Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListener extends Object implements Serializable


Serialized Fields


connectionPool
VirtualGatewayConnectionPool connectionPool

 The connection pool information for the virtual gateway listener.
 


healthCheck
VirtualGatewayHealthCheckPolicy healthCheck

 The health check information for the listener.
 


portMapping
VirtualGatewayPortMapping portMapping

 The port mapping information for the listener.
 


tls
VirtualGatewayListenerTls tls

 A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTls extends Object implements Serializable


Serialized Fields


certificate
VirtualGatewayListenerTlsCertificate certificate

 An object that represents a Transport Layer Security (TLS) certificate.
 


mode
String mode

 Specify one of the following modes.
 
 
 
 
 STRICT – Listener only accepts connections with TLS enabled.
 

 

 
 
 PERMISSIVE – Listener accepts connections with or without TLS enabled.
 

 

 
 
 DISABLED – Listener only accepts connections without TLS.
 

 

 



validation
VirtualGatewayListenerTlsValidationContext validation

 A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation
 context.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsAcmCertificate extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must
 have proxy authorization enabled. For more information, see Transport
 Layer Security (TLS).
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsCertificate extends Object implements Serializable


Serialized Fields


acm
VirtualGatewayListenerTlsAcmCertificate acm

 A reference to an object that represents an Certificate Manager certificate.
 


file
VirtualGatewayListenerTlsFileCertificate file

 A reference to an object that represents a local file certificate.
 


sds
VirtualGatewayListenerTlsSdsCertificate sds

 A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsFileCertificate extends Object implements Serializable


Serialized Fields


certificateChain
String certificateChain

 The certificate chain for the certificate.
 


privateKey
String privateKey

 The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsSdsCertificate extends Object implements Serializable


Serialized Fields


secretName
String secretName

 A reference to an object that represents the name of the secret secret requested from the Secret Discovery
 Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsValidationContext extends Object implements Serializable


Serialized Fields


subjectAlternativeNames
SubjectAlternativeNames subjectAlternativeNames

 A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS)
 validation context.
 


trust
VirtualGatewayListenerTlsValidationContextTrust trust

 A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
 certificate.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayListenerTlsValidationContextTrust extends Object implements Serializable


Serialized Fields


file
VirtualGatewayTlsValidationContextFileTrust file

 An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
 


sds
VirtualGatewayTlsValidationContextSdsTrust sds

 A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret
 Discovery Service validation context trust.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayLogging extends Object implements Serializable


Serialized Fields


accessLog
VirtualGatewayAccessLog accessLog

 The access log configuration.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayPortMapping extends Object implements Serializable


Serialized Fields


port
Integer port

 The port used for the port mapping. Specify one protocol.
 


protocol
String protocol

 The protocol used for the port mapping.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayRef 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.
 


meshName
String meshName

 The name of the service mesh that the resource resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


virtualGatewayName
String virtualGatewayName

 The name of the resource.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewaySpec extends Object implements Serializable


Serialized Fields


backendDefaults
VirtualGatewayBackendDefaults backendDefaults

 A reference to an object that represents the defaults for backends.
 


listeners
List<E> listeners

 The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
 


logging
VirtualGatewayLogging logging








Class com.amazonaws.services.appmesh.model.VirtualGatewayStatus extends Object implements Serializable


Serialized Fields


status
String status

 The current status.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayTlsValidationContext extends Object implements Serializable


Serialized Fields


subjectAlternativeNames
SubjectAlternativeNames subjectAlternativeNames

 A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security
 (TLS) validation context.
 


trust
VirtualGatewayTlsValidationContextTrust trust

 A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
 certificate.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayTlsValidationContextAcmTrust extends Object implements Serializable


Serialized Fields


certificateAuthorityArns
List<E> certificateAuthorityArns

 One or more ACM Amazon Resource Name (ARN)s.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayTlsValidationContextFileTrust extends Object implements Serializable


Serialized Fields


certificateChain
String certificateChain

 The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is
 running on.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayTlsValidationContextSdsTrust extends Object implements Serializable


Serialized Fields


secretName
String secretName

 A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security
 (TLS) Secret Discovery Service validation context trust.
 








Class com.amazonaws.services.appmesh.model.VirtualGatewayTlsValidationContextTrust extends Object implements Serializable


Serialized Fields


acm
VirtualGatewayTlsValidationContextAcmTrust acm

 A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an
 Certificate Manager certificate.
 


file
VirtualGatewayTlsValidationContextFileTrust file

 An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
 


sds
VirtualGatewayTlsValidationContextSdsTrust sds

 A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery
 Service validation context trust.
 








Class com.amazonaws.services.appmesh.model.VirtualNodeConnectionPool extends Object implements Serializable


Serialized Fields


grpc
VirtualNodeGrpcConnectionPool grpc

 An object that represents a type of connection pool.
 


http
VirtualNodeHttpConnectionPool http

 An object that represents a type of connection pool.
 


http2
VirtualNodeHttp2ConnectionPool http2

 An object that represents a type of connection pool.
 


tcp
VirtualNodeTcpConnectionPool tcp

 An object that represents a type of connection pool.
 








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.VirtualNodeGrpcConnectionPool extends Object implements Serializable


Serialized Fields


maxRequests
Integer maxRequests

 Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
 








Class com.amazonaws.services.appmesh.model.VirtualNodeHttp2ConnectionPool extends Object implements Serializable


Serialized Fields


maxRequests
Integer maxRequests

 Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
 








Class com.amazonaws.services.appmesh.model.VirtualNodeHttpConnectionPool extends Object implements Serializable


Serialized Fields


maxConnections
Integer maxConnections

 Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
 


maxPendingRequests
Integer maxPendingRequests

 Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
 








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.
 


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.
 


meshName
String meshName

 The name of the service mesh that the virtual node resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


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


backendDefaults
BackendDefaults backendDefaults

 A reference to an object that represents the defaults for backends.
 


backends
List<E> backends

 The backends that the virtual node is expected to send outbound traffic to.
 


listeners
List<E> listeners

 The listener 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. If you specify a listener, then you must specify service discovery
 information.
 








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.VirtualNodeTcpConnectionPool extends Object implements Serializable


Serialized Fields


maxConnections
Integer maxConnections

 Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
 








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.
 


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.
 


meshName
String meshName

 The name of the service mesh that the virtual router resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


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


clientPolicy
ClientPolicy clientPolicy

 A reference to an object that represents the client policy for a backend.
 


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.
 


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.
 


meshName
String meshName

 The name of the service mesh that the virtual service resides in.
 


meshOwner
String meshOwner

 The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
 the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
 


resourceOwner
String resourceOwner

 The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID
 of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing,
 see Working with shared meshes.
 


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.
 


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


port
Integer port

 The targeted port of the weighted object.
 


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




Class com.amazonaws.services.appregistry.model.Application extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the application.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the application across services.
 


name
String name

 The name of the application. The name must be unique in the region in which you are creating the application.
 


description
String description

 The description of the application.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment when the application was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment when the application was last updated.
 


tags
Map<K,V> tags

 Key-value pairs you can use to associate with the application.
 


applicationTag
Map<K,V> applicationTag

 A key-value pair that identifies an associated resource.
 








Class com.amazonaws.services.appregistry.model.ApplicationSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the application.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the application across services.
 


name
String name

 The name of the application. The name must be unique in the region in which you are creating the application.
 


description
String description

 The description of the application.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment when the application was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment when the application was last updated.
 








Class com.amazonaws.services.appregistry.model.ApplicationTagResult extends Object implements Serializable


Serialized Fields


applicationTagStatus
String applicationTagStatus

 The application tag is in the process of being applied to a resource, was successfully applied to a resource, or
 failed to apply to a resource.
 


errorMessage
String errorMessage

 The message returned if the call fails.
 


resources
List<E> resources

 The resources associated with an application
 


nextToken
String nextToken

 A unique pagination token for each page of results. Make the call again with the returned token to retrieve the
 next page of results.
 








Class com.amazonaws.services.appregistry.model.AppRegistryConfiguration extends Object implements Serializable


Serialized Fields


tagQueryConfiguration
TagQueryConfiguration tagQueryConfiguration

 Includes the definition of a tagQuery.
 








Class com.amazonaws.services.appregistry.model.AssociateAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 


attributeGroup
String attributeGroup

 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
 








Class com.amazonaws.services.appregistry.model.AssociateAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon resource name (ARN) of the application that was augmented with attributes.
 


attributeGroupArn
String attributeGroupArn

 The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.
 








Class com.amazonaws.services.appregistry.model.AssociateResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 


resourceType
String resourceType

 The type of resource of which the application will be associated.
 


resource
String resource

 The name or ID of the resource of which the application will be associated.
 


options
List<E> options

 Determines whether an application tag is applied or skipped.
 








Class com.amazonaws.services.appregistry.model.AssociateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon resource name (ARN) of the application that was augmented with attributes.
 


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 


options
List<E> options

 Determines whether an application tag is applied or skipped.
 








Class com.amazonaws.services.appregistry.model.AttributeGroup extends Object implements Serializable


Serialized Fields


id
String id

 The globally unique attribute group identifier of the attribute group.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the attribute group across services.
 


name
String name

 The name of the attribute group.
 


description
String description

 The description of the attribute group that the user provides.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment the attribute group was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the
 creationTime for a newly created attribute group.
 


tags
Map<K,V> tags

 Key-value pairs you can use to associate with the attribute group.
 








Class com.amazonaws.services.appregistry.model.AttributeGroupDetails extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the attribute group.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the attribute group.
 


name
String name

 
 This field is no longer supported. We recommend you don't use the field when using
 ListAttributeGroupsForApplication.
 
 
 
 The name of the attribute group.
 


createdBy
String createdBy

 The service principal that created the attribute group.
 








Class com.amazonaws.services.appregistry.model.AttributeGroupSummary extends Object implements Serializable


Serialized Fields


id
String id

 The globally unique attribute group identifier of the attribute group.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the attribute group across services.
 


name
String name

 The name of the attribute group.
 


description
String description

 The description of the attribute group that the user provides.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment the attribute group was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the
 creationTime for a newly created attribute group.
 


createdBy
String createdBy

 The service principal that created the attribute group.
 








Class com.amazonaws.services.appregistry.model.AWSAppRegistryException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appregistry.model.ConflictException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appregistry.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the application. The name must be unique in the region in which you are creating the application.
 


description
String description

 The description of the application.
 


tags
Map<K,V> tags

 Key-value pairs you can use to associate with the application.
 


clientToken
String clientToken

 A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully
 using the same client token and the same parameters, the retry succeeds without performing any further actions.
 If you retry a successful request using the same client token, but one or more of the parameters are different,
 the retry fails.
 








Class com.amazonaws.services.appregistry.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
Application application

 Information about the application.
 








Class com.amazonaws.services.appregistry.model.CreateAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the attribute group.
 


description
String description

 The description of the attribute group that the user provides.
 


attributes
String attributes

 A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an
 application and its components.
 


tags
Map<K,V> tags

 Key-value pairs you can use to associate with the attribute group.
 


clientToken
String clientToken

 A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully
 using the same client token and the same parameters, the retry succeeds without performing any further actions.
 If you retry a successful request using the same client token, but one or more of the parameters are different,
 the retry fails.
 








Class com.amazonaws.services.appregistry.model.CreateAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroup
AttributeGroup attributeGroup

 Information about the attribute group.
 








Class com.amazonaws.services.appregistry.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 








Class com.amazonaws.services.appregistry.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
ApplicationSummary application

 Information about the deleted application.
 








Class com.amazonaws.services.appregistry.model.DeleteAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeGroup
String attributeGroup

 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
 








Class com.amazonaws.services.appregistry.model.DeleteAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroup
AttributeGroupSummary attributeGroup

 Information about the deleted attribute group.
 








Class com.amazonaws.services.appregistry.model.DisassociateAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 


attributeGroup
String attributeGroup

 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
 








Class com.amazonaws.services.appregistry.model.DisassociateAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon resource name (ARN) that specifies the application.
 


attributeGroupArn
String attributeGroupArn

 The Amazon resource name (ARN) that specifies the attribute group.
 








Class com.amazonaws.services.appregistry.model.DisassociateResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name or ID of the application.
 


resourceType
String resourceType

 The type of the resource that is being disassociated.
 


resource
String resource

 The name or ID of the resource.
 








Class com.amazonaws.services.appregistry.model.DisassociateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon resource name (ARN) that specifies the application.
 


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 








Class com.amazonaws.services.appregistry.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 








Class com.amazonaws.services.appregistry.model.GetApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The identifier of the application.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the application across services.
 


name
String name

 The name of the application. The name must be unique in the region in which you are creating the application.
 


description
String description

 The description of the application.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment when the application was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment when the application was last updated.
 


associatedResourceCount
Integer associatedResourceCount

 The number of top-level resources that were registered as part of this application.
 


tags
Map<K,V> tags

 Key-value pairs associated with the application.
 


integrations
Integrations integrations

 The information about the integration of the application with other services, such as Resource Groups.
 


applicationTag
Map<K,V> applicationTag

 A key-value pair that identifies an associated resource.
 








Class com.amazonaws.services.appregistry.model.GetAssociatedResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 


resourceType
String resourceType

 The type of resource associated with the application.
 


resource
String resource

 The name or ID of the resource associated with the application.
 


nextToken
String nextToken

 A unique pagination token for each page of results. Make the call again with the returned token to retrieve the
 next page of results.
 


resourceTagStatus
List<E> resourceTagStatus

 States whether an application tag is applied, not applied, in the process of being applied, or skipped.
 


maxResults
Integer maxResults

 The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.
 








Class com.amazonaws.services.appregistry.model.GetAssociatedResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resource
Resource resource

 The resource associated with the application.
 


options
List<E> options

 Determines whether an application tag is applied or skipped.
 


applicationTagResult
ApplicationTagResult applicationTagResult

 The result of the application that's tag applied to a resource.
 








Class com.amazonaws.services.appregistry.model.GetAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeGroup
String attributeGroup

 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
 








Class com.amazonaws.services.appregistry.model.GetAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The identifier of the attribute group.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the attribute group across services.
 


name
String name

 The name of the attribute group.
 


description
String description

 The description of the attribute group that the user provides.
 


attributes
String attributes

 A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an
 application and its components.
 


creationTime
Date creationTime

 The ISO-8601 formatted timestamp of the moment the attribute group was created.
 


lastUpdateTime
Date lastUpdateTime

 The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the
 creationTime for a newly created attribute group.
 


tags
Map<K,V> tags

 Key-value pairs associated with the attribute group.
 


createdBy
String createdBy

 The service principal that created the attribute group.
 








Class com.amazonaws.services.appregistry.model.GetConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.appregistry.model.GetConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configuration
AppRegistryConfiguration configuration

 Retrieves TagKey configuration from an account.
 








Class com.amazonaws.services.appregistry.model.Integrations extends Object implements Serializable


Serialized Fields


resourceGroup
ResourceGroup resourceGroup

 The information about the resource group integration.
 


applicationTagResourceGroup
ResourceGroup applicationTagResourceGroup








Class com.amazonaws.services.appregistry.model.InternalServerException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appregistry.model.ListApplicationsRequest 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.
 


maxResults
Integer maxResults

 The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults
 to 25. This value is optional.
 








Class com.amazonaws.services.appregistry.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applications
List<E> applications

 This list of applications.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 








Class com.amazonaws.services.appregistry.model.ListAssociatedAttributeGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name or ID of the application.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 


maxResults
Integer maxResults

 The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults
 to 25. This value is optional.
 








Class com.amazonaws.services.appregistry.model.ListAssociatedAttributeGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroups
List<E> attributeGroups

 A list of attribute group IDs.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 








Class com.amazonaws.services.appregistry.model.ListAssociatedResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 


maxResults
Integer maxResults

 The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults
 to 25. This value is optional.
 








Class com.amazonaws.services.appregistry.model.ListAssociatedResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resources
List<E> resources

 Information about the resources.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 








Class com.amazonaws.services.appregistry.model.ListAttributeGroupsForApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name or ID of the application.
 


nextToken
String nextToken

 This token retrieves the next page of results after a previous API call.
 


maxResults
Integer maxResults

 The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it
 defaults to 25. This value is optional.
 








Class com.amazonaws.services.appregistry.model.ListAttributeGroupsForApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroupsDetails
List<E> attributeGroupsDetails

 The details related to a specific attribute group.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 








Class com.amazonaws.services.appregistry.model.ListAttributeGroupsRequest 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.
 


maxResults
Integer maxResults

 The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults
 to 25. This value is optional.
 








Class com.amazonaws.services.appregistry.model.ListAttributeGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroups
List<E> attributeGroups

 This list of attribute groups.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 








Class com.amazonaws.services.appregistry.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags on the resource.
 








Class com.amazonaws.services.appregistry.model.PutConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configuration
AppRegistryConfiguration configuration

 Associates a TagKey configuration to an account.
 








Class com.amazonaws.services.appregistry.model.PutConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


name
String name

 The name of the resource.
 


arn
String arn

 The Amazon resource name (ARN) of the resource.
 


associationTime
Date associationTime

 The time the resource was associated with the application.
 


integrations
ResourceIntegrations integrations

 The service integration information about the resource.
 








Class com.amazonaws.services.appregistry.model.ResourceDetails extends Object implements Serializable


Serialized Fields


tagValue
String tagValue

 The value of the tag.
 








Class com.amazonaws.services.appregistry.model.ResourceGroup extends Object implements Serializable


Serialized Fields


state
String state

 The state of the propagation process for the resource group. The states includes:
 
 
 CREATING if the resource group is in the process of being created.
 
 
 CREATE_COMPLETE if the resource group was created successfully.
 
 
 CREATE_FAILED if the resource group failed to be created.
 
 
 UPDATING if the resource group is in the process of being updated.
 
 
 UPDATE_COMPLETE if the resource group updated successfully.
 
 
 UPDATE_FAILED if the resource group could not update successfully.
 


arn
String arn

 The Amazon resource name (ARN) of the resource group.
 


errorMessage
String errorMessage

 The error message that generates when the propagation process for the resource group fails.
 








Class com.amazonaws.services.appregistry.model.ResourceInfo extends Object implements Serializable


Serialized Fields


name
String name

 The name of the resource.
 


arn
String arn

 The Amazon resource name (ARN) that specifies the resource across services.
 


resourceType
String resourceType

 Provides information about the Service Catalog App Registry resource type.
 


resourceDetails
ResourceDetails resourceDetails

 The details related to the resource.
 


options
List<E> options

 Determines whether an application tag is applied or skipped.
 








Class com.amazonaws.services.appregistry.model.ResourceIntegrations extends Object implements Serializable


Serialized Fields


resourceGroup
ResourceGroup resourceGroup

 The information about the integration of Resource Groups.
 








Class com.amazonaws.services.appregistry.model.ResourceNotFoundException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appregistry.model.ResourcesListItem extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon resource name (ARN) of the resource.
 


errorMessage
String errorMessage

 The message returned if the call fails.
 


status
String status

 The status of the list item.
 


resourceType
String resourceType

 Provides information about the AppRegistry resource type.
 








Class com.amazonaws.services.appregistry.model.ServiceQuotaExceededException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appregistry.model.SyncResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource of which the application will be associated.
 


resource
String resource

 An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web
 Services CloudFormation stack, or an Amazon S3 bucket.
 








Class com.amazonaws.services.appregistry.model.SyncResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon resource name (ARN) that specifies the application.
 


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 


actionTaken
String actionTaken

 The results of the output if an application is associated with an ARN value, which could be
 syncStarted or None.
 








Class com.amazonaws.services.appregistry.model.TagQueryConfiguration extends Object implements Serializable


Serialized Fields


tagKey
String tagKey

 Condition in the IAM policy that associates resources to an application.
 








Class com.amazonaws.services.appregistry.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 


tags
Map<K,V> tags

 The new or modified tags for the resource.
 








Class com.amazonaws.services.appregistry.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appregistry.model.ThrottlingException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L



Serialized Fields


serviceCode
String serviceCode

 The originating service code.
 








Class com.amazonaws.services.appregistry.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon resource name (ARN) that specifies the resource.
 


tagKeys
List<E> tagKeys

 A list of the tag keys to remove from the specified resource.
 








Class com.amazonaws.services.appregistry.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appregistry.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


application
String application

 The name, ID, or ARN of the application that will be updated.
 


name
String name
Deprecated. 

 Deprecated: The new name of the application. The name must be unique in the region in which you are updating the
 application. Please do not use this field as we have stopped supporting name updates.
 


description
String description

 The new description of the application.
 








Class com.amazonaws.services.appregistry.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
Application application

 The updated information of the application.
 








Class com.amazonaws.services.appregistry.model.UpdateAttributeGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeGroup
String attributeGroup

 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
 


name
String name
Deprecated. 

 Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating
 the attribute group. Please do not use this field as we have stopped supporting name updates.
 


description
String description

 The description of the attribute group that the user provides.
 


attributes
String attributes

 A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an
 application and its components.
 








Class com.amazonaws.services.appregistry.model.UpdateAttributeGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributeGroup
AttributeGroup attributeGroup

 The updated information of the attribute group.
 








Class com.amazonaws.services.appregistry.model.ValidationException extends AWSAppRegistryException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.apprunner.model




Class com.amazonaws.services.apprunner.model.AssociateCustomDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.
 


domainName
String domainName

 A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain
 (for example, login.example.com or admin.login.example.com), or a wildcard (for
 example, *.example.com).
 


enableWWWSubdomain
Boolean enableWWWSubdomain

 Set to true to associate the subdomain www.DomainName  with the App Runner
 service in addition to the base domain.
 
 
 Default: true
 








Class com.amazonaws.services.apprunner.model.AssociateCustomDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dNSTarget
String dNSTarget

 The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.
 


customDomain
CustomDomain customDomain

 A description of the domain name that's being associated.
 


vpcDNSTargets
List<E> vpcDNSTargets

 DNS Target records for the custom domains of this Amazon VPC.
 








Class com.amazonaws.services.apprunner.model.AuthenticationConfiguration extends Object implements Serializable


Serialized Fields


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a
 source repository. It's required for GitHub code repositories.
 


accessRoleArn
String accessRoleArn

 The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository.
 It's required for ECR image repositories (but not for ECR Public repositories).
 








Class com.amazonaws.services.apprunner.model.AutoScalingConfiguration extends Object implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of this auto scaling configuration.
 


autoScalingConfigurationName
String autoScalingConfigurationName

 The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
 


autoScalingConfigurationRevision
Integer autoScalingConfigurationRevision

 The revision of this auto scaling configuration. It's unique among all the active configurations (
 "Status": "ACTIVE") that share the same AutoScalingConfigurationName.
 


latest
Boolean latest

 It's set to true for the configuration with the highest Revision among all
 configurations that share the same AutoScalingConfigurationName. It's set to false
 otherwise.
 


status
String status

 The current state of the auto scaling configuration. If the status of a configuration revision is
 INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed
 some time after they are deleted.
 


maxConcurrency
Integer maxConcurrency

 The maximum number of concurrent requests that an instance processes. If the number of concurrent requests
 exceeds this limit, App Runner scales the service up.
 


minSize
Integer minSize

 The minimum number of instances that App Runner provisions for a service. The service always has at least
 MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned
 and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You
 pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
 
 
 App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same
 capacity for both old and new code.
 


maxSize
Integer maxSize

 The maximum number of instances that a service scales up to. At most MaxSize instances actively
 serve traffic for your service.
 


createdAt
Date createdAt

 The time when the auto scaling configuration was created. It's in Unix time stamp format.
 


deletedAt
Date deletedAt

 The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
 


hasAssociatedService
Boolean hasAssociatedService

 Indicates if this auto scaling configuration has an App Runner service associated with it. A value of
 true indicates one or more services are associated. A value of false indicates no
 services are associated.
 


isDefault
Boolean isDefault

 Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does
 not have an auto scaling configuration ARN specified during creation. Each account can have only one default
 AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any
 revision under the same AutoScalingConfigurationName.
 








Class com.amazonaws.services.apprunner.model.AutoScalingConfigurationSummary extends Object implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of this auto scaling configuration.
 


autoScalingConfigurationName
String autoScalingConfigurationName

 The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
 


autoScalingConfigurationRevision
Integer autoScalingConfigurationRevision

 The revision of this auto scaling configuration. It's unique among all the active configurations (
 "Status": "ACTIVE") with the same AutoScalingConfigurationName.
 


status
String status

 The current state of the auto scaling configuration. If the status of a configuration revision is
 INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed
 some time after they are deleted.
 


createdAt
Date createdAt

 The time when the auto scaling configuration was created. It's in Unix time stamp format.
 


hasAssociatedService
Boolean hasAssociatedService

 Indicates if this auto scaling configuration has an App Runner service associated with it. A value of
 true indicates one or more services are associated. A value of false indicates no
 services are associated.
 


isDefault
Boolean isDefault

 Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does
 not have an auto scaling configuration ARN specified during creation. Each account can have only one default
 AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any
 revision under the same AutoScalingConfigurationName.
 








Class com.amazonaws.services.apprunner.model.AWSAppRunnerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.CertificateValidationRecord extends Object implements Serializable


Serialized Fields


name
String name

 The certificate CNAME record name.
 


type
String type

 The record type, always CNAME.
 


value
String value

 The certificate CNAME record value.
 


status
String status

 The current state of the certificate CNAME record validation. It should change to SUCCESS after App
 Runner completes validation with your DNS.
 








Class com.amazonaws.services.apprunner.model.CodeConfiguration extends Object implements Serializable


Serialized Fields


configurationSource
String configurationSource

 The source of the App Runner configuration. Values are interpreted as follows:
 
 
 
 
 REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the
 source code repository and ignores CodeConfigurationValues.
 
 
 
 
 API – App Runner uses configuration values provided in CodeConfigurationValues and
 ignores the apprunner.yaml file in the source code repository.
 
 
 


codeConfigurationValues
CodeConfigurationValues codeConfigurationValues

 The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner
 service without providing a apprunner.yaml file in the source code repository (or ignoring the file
 if it exists).
 








Class com.amazonaws.services.apprunner.model.CodeConfigurationValues extends Object implements Serializable


Serialized Fields


runtime
String runtime

 A runtime environment type for building and running an App Runner service. It represents a programming language
 runtime.
 


buildCommand
String buildCommand

 The command App Runner runs to build your application.
 


startCommand
String startCommand

 The command App Runner runs to start your application.
 


port
String port

 The port that your application listens to in the container.
 
 
 Default: 8080
 


runtimeEnvironmentVariables
Map<K,V> runtimeEnvironmentVariables

 The environment variables that are available to your running App Runner service. An array of key-value pairs.
 


runtimeEnvironmentSecrets
Map<K,V> runtimeEnvironmentSecrets

 An array of key-value pairs representing the secrets and parameters that get referenced to your service as an
 environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager
 secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
 
 
 
 
 
 If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services
 Region as the service that you're launching, you can use either the full ARN or name of the secret. If the
 parameter exists in a different Region, then the full ARN must be specified.
 
 
 
 
 Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not
 supported.
 
 
 
 








Class com.amazonaws.services.apprunner.model.CodeRepository extends Object implements Serializable


Serialized Fields


repositoryUrl
String repositoryUrl

 The location of the repository that contains the source code.
 


sourceCodeVersion
SourceCodeVersion sourceCodeVersion

 The version that should be used within the source code repository.
 


codeConfiguration
CodeConfiguration codeConfiguration

 Configuration for building and running the service from a source code repository.
 
 
 
 CodeConfiguration is required only for CreateService request.
 
 


sourceDirectory
String sourceDirectory

 The path of the directory that stores source code and configuration files. The build and start commands also
 execute from here. The path is absolute from root and, if not specified, defaults to the repository root.
 








Class com.amazonaws.services.apprunner.model.Connection extends Object implements Serializable


Serialized Fields


connectionName
String connectionName

 The customer-provided connection name.
 


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of this connection.
 


providerType
String providerType

 The source repository provider.
 


status
String status

 The current state of the App Runner connection. When the state is AVAILABLE, you can use the
 connection to create an App Runner service.
 


createdAt
Date createdAt

 The App Runner connection creation time, expressed as a Unix time stamp.
 








Class com.amazonaws.services.apprunner.model.ConnectionSummary extends Object implements Serializable


Serialized Fields


connectionName
String connectionName

 The customer-provided connection name.
 


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of this connection.
 


providerType
String providerType

 The source repository provider.
 


status
String status

 The current state of the App Runner connection. When the state is AVAILABLE, you can use the
 connection to create an App Runner service.
 


createdAt
Date createdAt

 The App Runner connection creation time, expressed as a Unix time stamp.
 








Class com.amazonaws.services.apprunner.model.CreateAutoScalingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationName
String autoScalingConfigurationName

 A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region,
 App Runner creates revision number 1 of this name. When you use the same name in subsequent calls,
 App Runner creates incremental revisions of the configuration.
 
 
 
 Prior to the release of Auto scale
 configuration enhancements, the name DefaultConfiguration was reserved.
 
 
 This restriction is no longer in place. You can now manage DefaultConfiguration the same way you
 manage your custom auto scaling configurations. This means you can do the following with the
 DefaultConfiguration that App Runner provides:
 
 
 
 
 Create new revisions of the DefaultConfiguration.
 
 
 
 
 Delete the revisions of the DefaultConfiguration.
 
 
 
 
 Delete the auto scaling configuration for which the App Runner DefaultConfiguration was created.
 
 
 
 
 If you delete the auto scaling configuration you can create another custom auto scaling configuration with the
 same DefaultConfiguration name. The original DefaultConfiguration resource provided by
 App Runner remains in your account unless you make changes to it.
 
 
 
 


maxConcurrency
Integer maxConcurrency

 The maximum number of concurrent requests that you want an instance to process. If the number of concurrent
 requests exceeds this limit, App Runner scales up your service.
 
 
 Default: 100
 


minSize
Integer minSize

 The minimum number of instances that App Runner provisions for your service. The service always has at least
 MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned
 and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You
 pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.
 
 
 App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same
 capacity for both old and new code.
 
 
 Default: 1
 


maxSize
Integer maxSize

 The maximum number of instances that your service scales up to. At most MaxSize instances actively
 serve traffic for your service.
 
 
 Default: 25
 


tags
List<E> tags

 A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a
 key-value pair.
 








Class com.amazonaws.services.apprunner.model.CreateAutoScalingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoScalingConfiguration
AutoScalingConfiguration autoScalingConfiguration

 A description of the App Runner auto scaling configuration that's created by this request.
 








Class com.amazonaws.services.apprunner.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionName
String connectionName

 A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services
 account in the Amazon Web Services Region.
 


providerType
String providerType

 The source repository provider.
 


tags
List<E> tags

 A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.
 








Class com.amazonaws.services.apprunner.model.CreateConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 A description of the App Runner connection that's created by this request.
 








Class com.amazonaws.services.apprunner.model.CreateObservabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


observabilityConfigurationName
String observabilityConfigurationName

 A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region,
 App Runner creates revision number 1 of this name. When you use the same name in subsequent calls,
 App Runner creates incremental revisions of the configuration.
 
 
 
 The name DefaultConfiguration is reserved. You can't use it to create a new observability
 configuration, and you can't create a revision of it.
 
 
 When you want to use your own observability configuration for your App Runner service, create a configuration
 with a different name, and then provide it when you create or update your service.
 
 


traceConfiguration
TraceConfiguration traceConfiguration

 The configuration of the tracing feature within this observability configuration. If you don't specify it, App
 Runner doesn't enable tracing.
 


tags
List<E> tags

 A list of metadata items that you can associate with your observability configuration resource. A tag is a
 key-value pair.
 








Class com.amazonaws.services.apprunner.model.CreateObservabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


observabilityConfiguration
ObservabilityConfiguration observabilityConfiguration

 A description of the App Runner observability configuration that's created by this request.
 








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


Serialized Fields


serviceName
String serviceName

 A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon
 Web Services account in the Amazon Web Services Region.
 


sourceConfiguration
SourceConfiguration sourceConfiguration

 The source to deploy to the App Runner service. It can be a code or an image repository.
 


instanceConfiguration
InstanceConfiguration instanceConfiguration

 The runtime configuration of instances (scaling units) of your service.
 


tags
List<E> tags

 An optional list of metadata items that you can associate with the App Runner service resource. A tag is a
 key-value pair.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it
 maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.
 


healthCheckConfiguration
HealthCheckConfiguration healthCheckConfiguration

 The settings for the health check that App Runner performs to monitor the health of the App Runner service.
 


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to
 associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling
 configuration.
 
 
 Specify an ARN with a name and a revision number to associate that revision. For example:
 arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
 
 
 Specify just the name to associate the latest revision. For example:
 arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
 


networkConfiguration
NetworkConfiguration networkConfiguration

 Configuration settings related to network traffic of the web application that the App Runner service runs.
 


observabilityConfiguration
ServiceObservabilityConfiguration observabilityConfiguration

 The observability configuration of your service.
 








Class com.amazonaws.services.apprunner.model.CreateServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A description of the App Runner service that's created by this request.
 


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track
 the operation's progress.
 








Class com.amazonaws.services.apprunner.model.CreateVpcConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcConnectorName
String vpcConnectorName

 A name for the VPC connector.
 


subnets
List<E> subnets

 A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.
 Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
 
 
 
 App Runner currently only provides support for IPv4.
 
 


securityGroups
List<E> securityGroups

 A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the
 specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default
 security group allows all outbound traffic.
 


tags
List<E> tags

 A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
 








Class com.amazonaws.services.apprunner.model.CreateVpcConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcConnector
VpcConnector vpcConnector

 A description of the App Runner VPC connector that's created by this request.
 








Class com.amazonaws.services.apprunner.model.CreateVpcIngressConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection
 resource.
 


vpcIngressConnectionName
String vpcIngressConnectionName

 A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections
 in your Amazon Web Services account in the Amazon Web Services Region.
 


ingressVpcConfiguration
IngressVpcConfiguration ingressVpcConfiguration

 Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that
 are used to create the VPC Ingress Connection resource.
 


tags
List<E> tags

 An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a
 key-value pair.
 








Class com.amazonaws.services.apprunner.model.CreateVpcIngressConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcIngressConnection
VpcIngressConnection vpcIngressConnection

 A description of the App Runner VPC Ingress Connection resource that's created by this request.
 








Class com.amazonaws.services.apprunner.model.CustomDomain extends Object implements Serializable


Serialized Fields


domainName
String domainName

 An associated custom domain endpoint. It can be a root domain (for example, example.com), a
 subdomain (for example, login.example.com or admin.login.example.com), or a wildcard
 (for example, *.example.com).
 


enableWWWSubdomain
Boolean enableWWWSubdomain

 When true, the subdomain www.DomainName  is associated with the App Runner
 service in addition to the base domain.
 


certificateValidationRecords
List<E> certificateValidationRecords

 A list of certificate CNAME records that's used for this domain name.
 


status
String status

 The current state of the domain name association.
 








Class com.amazonaws.services.apprunner.model.DeleteAutoScalingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.
 
 
 The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is deleted.
 


deleteAllRevisions
Boolean deleteAllRevisions

 Set to true to delete all of the revisions associated with the
 AutoScalingConfigurationArn parameter value.
 
 
 When DeleteAllRevisions is set to true, the only valid value for the Amazon Resource
 Name (ARN) is a partial ARN ending with: .../name.
 








Class com.amazonaws.services.apprunner.model.DeleteAutoScalingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoScalingConfiguration
AutoScalingConfiguration autoScalingConfiguration

 A description of the App Runner auto scaling configuration that this request just deleted.
 








Class com.amazonaws.services.apprunner.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.
 








Class com.amazonaws.services.apprunner.model.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 A description of the App Runner connection that this request just deleted.
 








Class com.amazonaws.services.apprunner.model.DeleteObservabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


observabilityConfigurationArn
String observabilityConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.
 
 
 The ARN can be a full observability configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is deleted.
 








Class com.amazonaws.services.apprunner.model.DeleteObservabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


observabilityConfiguration
ObservabilityConfiguration observabilityConfiguration

 A description of the App Runner observability configuration that this request just deleted.
 








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


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to delete.
 








Class com.amazonaws.services.apprunner.model.DeleteServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A description of the App Runner service that this request just deleted.
 


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the
 ListOperations call to track the operation's progress.
 








Class com.amazonaws.services.apprunner.model.DeleteVpcConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcConnectorArn
String vpcConnectorArn

 The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.
 
 
 The ARN must be a full VPC connector ARN.
 








Class com.amazonaws.services.apprunner.model.DeleteVpcConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcConnector
VpcConnector vpcConnector

 A description of the App Runner VPC connector that this request just deleted.
 








Class com.amazonaws.services.apprunner.model.DeleteVpcIngressConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.
 








Class com.amazonaws.services.apprunner.model.DeleteVpcIngressConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcIngressConnection
VpcIngressConnection vpcIngressConnection

 A description of the App Runner VPC Ingress Connection that this request just deleted.
 








Class com.amazonaws.services.apprunner.model.DescribeAutoScalingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.
 
 
 The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is described.
 








Class com.amazonaws.services.apprunner.model.DescribeAutoScalingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoScalingConfiguration
AutoScalingConfiguration autoScalingConfiguration

 A full description of the App Runner auto scaling configuration that you specified in this request.
 








Class com.amazonaws.services.apprunner.model.DescribeCustomDomainsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be
 described for.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones that are specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 


maxResults
Integer maxResults

 The maximum number of results that each response (result page) can include. It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 








Class com.amazonaws.services.apprunner.model.DescribeCustomDomainsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dNSTarget
String dNSTarget

 The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target
 name.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to
 describe.
 


customDomains
List<E> customDomains

 A list of descriptions of custom domain names that are associated with the service. In a paginated request, the
 request returns up to MaxResults records per call.
 


vpcDNSTargets
List<E> vpcDNSTargets

 DNS Target records for the custom domains of this Amazon VPC.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.DescribeObservabilityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


observabilityConfigurationArn
String observabilityConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.
 
 
 The ARN can be a full observability configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is described.
 








Class com.amazonaws.services.apprunner.model.DescribeObservabilityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


observabilityConfiguration
ObservabilityConfiguration observabilityConfiguration

 A full description of the App Runner observability configuration that you specified in this request.
 








Class com.amazonaws.services.apprunner.model.DescribeServiceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want a description for.
 








Class com.amazonaws.services.apprunner.model.DescribeServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A full description of the App Runner service that you specified in this request.
 








Class com.amazonaws.services.apprunner.model.DescribeVpcConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcConnectorArn
String vpcConnectorArn

 The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.
 
 
 The ARN must be a full VPC connector ARN.
 








Class com.amazonaws.services.apprunner.model.DescribeVpcConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcConnector
VpcConnector vpcConnector

 A description of the App Runner VPC connector that you specified in this request.
 








Class com.amazonaws.services.apprunner.model.DescribeVpcIngressConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
 








Class com.amazonaws.services.apprunner.model.DescribeVpcIngressConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcIngressConnection
VpcIngressConnection vpcIngressConnection

 A description of the App Runner VPC Ingress Connection that you specified in this request.
 








Class com.amazonaws.services.apprunner.model.DisassociateCustomDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.
 


domainName
String domainName

 The domain name that you want to disassociate from the App Runner service.
 








Class com.amazonaws.services.apprunner.model.DisassociateCustomDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dNSTarget
String dNSTarget

 The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this
 target name.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.
 


customDomain
CustomDomain customDomain

 A description of the domain name that's being disassociated.
 


vpcDNSTargets
List<E> vpcDNSTargets

 DNS Target records for the custom domains of this Amazon VPC.
 








Class com.amazonaws.services.apprunner.model.EgressConfiguration extends Object implements Serializable


Serialized Fields


egressType
String egressType

 The type of egress configuration.
 
 
 Set to DEFAULT for access to resources hosted on public networks.
 
 
 Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.
 


vpcConnectorArn
String vpcConnectorArn

 The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner
 service. Only valid when EgressType = VPC.
 








Class com.amazonaws.services.apprunner.model.EncryptionConfiguration extends Object implements Serializable


Serialized Fields


kmsKey
String kmsKey

 The ARN of the KMS key that's used for encryption.
 








Class com.amazonaws.services.apprunner.model.HealthCheckConfiguration extends Object implements Serializable


Serialized Fields


protocol
String protocol

 The IP protocol that App Runner uses to perform health checks for your service.
 
 
 If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path
 specified by Path.
 
 
 Default: TCP
 


path
String path

 The URL that health check requests are sent to.
 
 
 Path is only applicable when you set Protocol to HTTP.
 
 
 Default: "/"
 


interval
Integer interval

 The time interval, in seconds, between health checks.
 
 
 Default: 5
 


timeout
Integer timeout

 The time, in seconds, to wait for a health check response before deciding it failed.
 
 
 Default: 2
 


healthyThreshold
Integer healthyThreshold

 The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
 
 
 Default: 1
 


unhealthyThreshold
Integer unhealthyThreshold

 The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
 
 
 Default: 5
 








Class com.amazonaws.services.apprunner.model.ImageConfiguration extends Object implements Serializable


Serialized Fields


runtimeEnvironmentVariables
Map<K,V> runtimeEnvironmentVariables

 Environment variables that are available to your running App Runner service. An array of key-value pairs.
 


startCommand
String startCommand

 An optional command that App Runner runs to start the application in the source image. If specified, this command
 overrides the Docker image’s default start command.
 


port
String port

 The port that your application listens to in the container.
 
 
 Default: 8080
 


runtimeEnvironmentSecrets
Map<K,V> runtimeEnvironmentSecrets

 An array of key-value pairs representing the secrets and parameters that get referenced to your service as an
 environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager
 secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
 
 
 
 
 
 If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services
 Region as the service that you're launching, you can use either the full ARN or name of the secret. If the
 parameter exists in a different Region, then the full ARN must be specified.
 
 
 
 
 Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not
 supported.
 
 
 
 








Class com.amazonaws.services.apprunner.model.ImageRepository extends Object implements Serializable


Serialized Fields


imageIdentifier
String imageIdentifier

 The identifier of an image.
 
 
 For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format,
 see Pulling an
 image in the Amazon ECR User Guide.
 


imageConfiguration
ImageConfiguration imageConfiguration

 Configuration for running the identified image.
 


imageRepositoryType
String imageRepositoryType

 The type of the image repository. This reflects the repository provider and whether the repository is private or
 public.
 








Class com.amazonaws.services.apprunner.model.IngressConfiguration extends Object implements Serializable


Serialized Fields


isPubliclyAccessible
Boolean isPubliclyAccessible

 Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it
 to True. To make the service privately accessible, from only within an Amazon VPC set it to
 False.
 








Class com.amazonaws.services.apprunner.model.IngressVpcConfiguration extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC that is used for the VPC endpoint.
 


vpcEndpointId
String vpcEndpointId

 The ID of the VPC endpoint that your App Runner service connects to.
 








Class com.amazonaws.services.apprunner.model.InstanceConfiguration extends Object implements Serializable


Serialized Fields


cpu
String cpu

 The number of CPU units reserved for each instance of your App Runner service.
 
 
 Default: 1 vCPU
 


memory
String memory

 The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
 
 
 Default: 2 GB
 


instanceRoleArn
String instanceRoleArn

 The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are
 permissions that your code needs when it calls any Amazon Web Services APIs.
 








Class com.amazonaws.services.apprunner.model.InternalServiceErrorException extends AWSAppRunnerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.InvalidRequestException extends AWSAppRunnerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.InvalidStateException extends AWSAppRunnerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.ListAutoScalingConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationName
String autoScalingConfigurationName

 The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists
 revisions that share this name. If not specified, App Runner returns revisions of all active configurations.
 


latestOnly
Boolean latestOnly

 Set to true to list only the latest revision for each requested configuration name.
 
 
 Set to false to list all revisions for each requested configuration name.
 
 
 Default: true
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones that are specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListAutoScalingConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoScalingConfigurationSummaryList
List<E> autoScalingConfigurationSummaryList

 A list of summary information records for auto scaling configurations. In a paginated request, the request
 returns up to MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.ListConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionName
String connectionName

 If specified, only this connection is returned. If not specified, the result isn't filtered by name.
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). Used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. Used for a paginated request. The request retrieves the next result page.
 All other parameter values must be identical to the ones specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionSummaryList
List<E> connectionSummaryList

 A list of summary information records for connections. In a paginated request, the request returns up to
 MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
 








Class com.amazonaws.services.apprunner.model.ListObservabilityConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


observabilityConfigurationName
String observabilityConfigurationName

 The name of the App Runner observability configuration that you want to list. If specified, App Runner lists
 revisions that share this name. If not specified, App Runner returns revisions of all active configurations.
 


latestOnly
Boolean latestOnly

 Set to true to list only the latest revision for each requested configuration name.
 
 
 Set to false to list all revisions for each requested configuration name.
 
 
 Default: true
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones that are specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListObservabilityConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


observabilityConfigurationSummaryList
List<E> observabilityConfigurationSummaryList

 A list of summary information records for observability configurations. In a paginated request, the request
 returns up to MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.ListOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 








Class com.amazonaws.services.apprunner.model.ListOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationSummaryList
List<E> operationSummaryList

 A list of operation summary information records. In a paginated request, the request returns up to
 MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.ListServicesForAutoScalingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to list the services
 for.
 
 
 The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is used.
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListServicesForAutoScalingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceArnList
List<E> serviceArnList

 A list of service ARN records. In a paginated request, the request returns up to MaxResults records
 for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








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


Serialized Fields


nextToken
String nextToken

 A token from a previous result page. Used for a paginated request. The request retrieves the next result page.
 All other parameter values must be identical to the ones specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 








Class com.amazonaws.services.apprunner.model.ListServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSummaryList
List<E> serviceSummaryList

 A list of service summary information records. In a paginated request, the request returns up to
 MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that a tag list is requested for.
 
 
 It must be the ARN of an App Runner resource.
 








Class com.amazonaws.services.apprunner.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A list of the tag key-value pairs that are associated with the resource.
 








Class com.amazonaws.services.apprunner.model.ListVpcConnectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones that are specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListVpcConnectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcConnectors
List<E> vpcConnectors

 A list of information records for VPC connectors. In a paginated request, the request returns up to
 MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.ListVpcIngressConnectionsFilter extends Object implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of a service to filter by.
 


vpcEndpointId
String vpcEndpointId

 The ID of a VPC Endpoint to filter by.
 








Class com.amazonaws.services.apprunner.model.ListVpcIngressConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
ListVpcIngressConnectionsFilter filter

 The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.
 


maxResults
Integer maxResults

 The maximum number of results to include in each response (result page). It's used for a paginated request.
 
 
 If you don't specify MaxResults, the request retrieves all available results in a single response.
 


nextToken
String nextToken

 A token from a previous result page. It's used for a paginated request. The request retrieves the next result
 page. All other parameter values must be identical to the ones that are specified in the initial request.
 
 
 If you don't specify NextToken, the request retrieves the first result page.
 








Class com.amazonaws.services.apprunner.model.ListVpcIngressConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcIngressConnectionSummaryList
List<E> vpcIngressConnectionSummaryList

 A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up
 to MaxResults records for each call.
 


nextToken
String nextToken

 The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated
 request.
 








Class com.amazonaws.services.apprunner.model.NetworkConfiguration extends Object implements Serializable


Serialized Fields


egressConfiguration
EgressConfiguration egressConfiguration

 Network configuration settings for outbound message traffic.
 


ingressConfiguration
IngressConfiguration ingressConfiguration

 Network configuration settings for inbound message traffic.
 


ipAddressType
String ipAddressType

 App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual
 stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you
 do not specify an IpAddressType, it defaults to select IPv4.
 
 
 
 Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint.
 If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service
 will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6
 endpoint.
 
 








Class com.amazonaws.services.apprunner.model.ObservabilityConfiguration extends Object implements Serializable


Serialized Fields


observabilityConfigurationArn
String observabilityConfigurationArn

 The Amazon Resource Name (ARN) of this observability configuration.
 


observabilityConfigurationName
String observabilityConfigurationName

 The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
 


traceConfiguration
TraceConfiguration traceConfiguration

 The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't
 enabled.
 


observabilityConfigurationRevision
Integer observabilityConfigurationRevision

 The revision of this observability configuration. It's unique among all the active configurations (
 "Status": "ACTIVE") that share the same ObservabilityConfigurationName.
 


latest
Boolean latest

 It's set to true for the configuration with the highest Revision among all
 configurations that share the same ObservabilityConfigurationName. It's set to false
 otherwise.
 


status
String status

 The current state of the observability configuration. If the status of a configuration revision is
 INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed
 some time after they are deleted.
 


createdAt
Date createdAt

 The time when the observability configuration was created. It's in Unix time stamp format.
 


deletedAt
Date deletedAt

 The time when the observability configuration was deleted. It's in Unix time stamp format.
 








Class com.amazonaws.services.apprunner.model.ObservabilityConfigurationSummary extends Object implements Serializable


Serialized Fields


observabilityConfigurationArn
String observabilityConfigurationArn

 The Amazon Resource Name (ARN) of this observability configuration.
 


observabilityConfigurationName
String observabilityConfigurationName

 The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
 


observabilityConfigurationRevision
Integer observabilityConfigurationRevision

 The revision of this observability configuration. It's unique among all the active configurations (
 "Status": "ACTIVE") that share the same ObservabilityConfigurationName.
 








Class com.amazonaws.services.apprunner.model.OperationSummary extends Object implements Serializable


Serialized Fields


id
String id

 A unique ID of this operation. It's unique in the scope of the App Runner service.
 


type
String type

 The type of operation. It indicates a specific action that occured.
 


status
String status

 The current state of the operation.
 


targetArn
String targetArn

 The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).
 


startedAt
Date startedAt

 The time when the operation started. It's in the Unix time stamp format.
 


endedAt
Date endedAt

 The time when the operation ended. It's in the Unix time stamp format.
 


updatedAt
Date updatedAt

 The time when the operation was last updated. It's in the Unix time stamp format.
 








Class com.amazonaws.services.apprunner.model.PauseServiceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to pause.
 








Class com.amazonaws.services.apprunner.model.PauseServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A description of the App Runner service that this request just paused.
 


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the
 ListOperations call to track the operation's progress.
 








Class com.amazonaws.services.apprunner.model.ResourceNotFoundException extends AWSAppRunnerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.ResumeServiceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
 








Class com.amazonaws.services.apprunner.model.ResumeServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A description of the App Runner service that this request just resumed.
 


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the
 ListOperations call to track the operation's progress.
 








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


Serialized Fields


serviceName
String serviceName

 The customer-provided service name.
 


serviceId
String serviceId

 An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of this service.
 


serviceUrl
String serviceUrl

 A subdomain URL that App Runner generated for this service. You can use this URL to access your service web
 application.
 


createdAt
Date createdAt

 The time when the App Runner service was created. It's in the Unix time stamp format.
 


updatedAt
Date updatedAt

 The time when the App Runner service was last updated at. It's in the Unix time stamp format.
 


deletedAt
Date deletedAt

 The time when the App Runner service was deleted. It's in the Unix time stamp format.
 


status
String status

 The current state of the App Runner service. These particular values mean the following.
 
 
 
 
 CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts
 towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters
 that need to be fixed, and rebuild your service using UpdateService.
 
 
 
 
 DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service
 deletion call to ensure that all related resources are removed.
 
 
 


sourceConfiguration
SourceConfiguration sourceConfiguration

 The source deployed to the App Runner service. It can be a code or an image repository.
 


instanceConfiguration
InstanceConfiguration instanceConfiguration

 The runtime configuration of instances (scaling units) of this service.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that
 App Runner maintains for the service. It can be either a customer-provided encryption key or an Amazon Web
 Services managed key.
 


healthCheckConfiguration
HealthCheckConfiguration healthCheckConfiguration

 The settings for the health check that App Runner performs to monitor the health of this service.
 


autoScalingConfigurationSummary
AutoScalingConfigurationSummary autoScalingConfigurationSummary

 Summary information for the App Runner automatic scaling configuration resource that's associated with this
 service.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 Configuration settings related to network traffic of the web application that this service runs.
 


observabilityConfiguration
ServiceObservabilityConfiguration observabilityConfiguration

 The observability configuration of this service.
 








Class com.amazonaws.services.apprunner.model.ServiceObservabilityConfiguration extends Object implements Serializable


Serialized Fields


observabilityEnabled
Boolean observabilityEnabled

 When true, an observability configuration resource is associated with the service, and an
 ObservabilityConfigurationArn is specified.
 


observabilityConfigurationArn
String observabilityConfigurationArn

 The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified
 only when ObservabilityEnabled is true.
 
 
 Specify an ARN with a name and a revision number to associate that revision. For example:
 arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3
 
 
 Specify just the name to associate the latest revision. For example:
 arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing
 








Class com.amazonaws.services.apprunner.model.ServiceQuotaExceededException extends AWSAppRunnerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apprunner.model.ServiceSummary extends Object implements Serializable


Serialized Fields


serviceName
String serviceName

 The customer-provided service name.
 


serviceId
String serviceId

 An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of this service.
 


serviceUrl
String serviceUrl

 A subdomain URL that App Runner generated for this service. You can use this URL to access your service web
 application.
 


createdAt
Date createdAt

 The time when the App Runner service was created. It's in the Unix time stamp format.
 


updatedAt
Date updatedAt

 The time when the App Runner service was last updated. It's in theUnix time stamp format.
 


status
String status

 The current state of the App Runner service. These particular values mean the following.
 
 
 
 
 CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts
 towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters
 that need to be fixed, and rebuild your service using UpdateService.
 
 
 
 
 DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service
 deletion call to ensure that all related resources are removed.
 
 
 








Class com.amazonaws.services.apprunner.model.SourceCodeVersion extends Object implements Serializable


Serialized Fields


type
String type

 The type of version identifier.
 
 
 For a git-based repository, branches represent versions.
 


value
String value

 A source code version.
 
 
 For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to
 the branch.
 








Class com.amazonaws.services.apprunner.model.SourceConfiguration extends Object implements Serializable


Serialized Fields


codeRepository
CodeRepository codeRepository

 The description of a source code repository.
 
 
 You must provide either this member or ImageRepository (but not both).
 


imageRepository
ImageRepository imageRepository

 The description of a source image repository.
 
 
 You must provide either this member or CodeRepository (but not both).
 


autoDeploymentsEnabled
Boolean autoDeploymentsEnabled

 If true, continuous integration from the source repository is enabled for the App Runner service.
 Each repository change (including any source code commit or new image version) starts a deployment.
 
 
 Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR
 repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to
 true in all other cases (which currently include a source code repository or a source image using a
 same-account ECR repository).
 


authenticationConfiguration
AuthenticationConfiguration authenticationConfiguration

 Describes the resources that are needed to authenticate access to some source repositories.
 








Class com.amazonaws.services.apprunner.model.StartDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.
 








Class com.amazonaws.services.apprunner.model.StartDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the
 ListOperations call to track the operation's progress.
 








Class com.amazonaws.services.apprunner.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.apprunner.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to update tags for.
 
 
 It must be the ARN of an App Runner resource.
 


tags
List<E> tags

 A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the
 provided value. If a key is already associated with the resource, the value of the tag is updated.
 








Class com.amazonaws.services.apprunner.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.apprunner.model.TraceConfiguration extends Object implements Serializable


Serialized Fields


vendor
String vendor

 The implementation provider chosen for tracing App Runner services.
 








Class com.amazonaws.services.apprunner.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
 
 
 It must be the ARN of an App Runner resource.
 


tagKeys
List<E> tagKeys

 A list of tag keys that you want to remove.
 








Class com.amazonaws.services.apprunner.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.apprunner.model.UpdateDefaultAutoScalingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to set as the default.
 
 
 The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either
 .../name  or .../name/revision . If a revision isn't specified,
 the latest active revision is set as the default.
 








Class com.amazonaws.services.apprunner.model.UpdateDefaultAutoScalingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoScalingConfiguration
AutoScalingConfiguration autoScalingConfiguration

 A description of the App Runner auto scaling configuration that was set as default.
 








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


Serialized Fields


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the App Runner service that you want to update.
 


sourceConfiguration
SourceConfiguration sourceConfiguration

 The source configuration to apply to the App Runner service.
 
 
 You can change the configuration of the code or image repository that the service uses. However, you can't switch
 from code to image or the other way around. This means that you must provide the same structure member of
 SourceConfiguration that you originally included when you created the service. Specifically, you can
 include either CodeRepository or ImageRepository. To update the source configuration,
 set the values to members of the structure that you include.
 


instanceConfiguration
InstanceConfiguration instanceConfiguration

 The runtime configuration to apply to instances (scaling units) of your service.
 


autoScalingConfigurationArn
String autoScalingConfigurationArn

 The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to
 associate with the App Runner service.
 


healthCheckConfiguration
HealthCheckConfiguration healthCheckConfiguration

 The settings for the health check that App Runner performs to monitor the health of the App Runner service.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 Configuration settings related to network traffic of the web application that the App Runner service runs.
 


observabilityConfiguration
ServiceObservabilityConfiguration observabilityConfiguration

 The observability configuration of your service.
 








Class com.amazonaws.services.apprunner.model.UpdateServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 A description of the App Runner service updated by this request. All configuration values in the returned
 Service structure reflect configuration changes that are being applied by this request.
 


operationId
String operationId

 The unique ID of the asynchronous operation that this request started. You can use it combined with the
 ListOperations call to track the operation's progress.
 








Class com.amazonaws.services.apprunner.model.UpdateVpcIngressConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.
 


ingressVpcConfiguration
IngressVpcConfiguration ingressVpcConfiguration

 Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that
 are used to update the VPC Ingress Connection resource.
 








Class com.amazonaws.services.apprunner.model.UpdateVpcIngressConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcIngressConnection
VpcIngressConnection vpcIngressConnection

 A description of the App Runner VPC Ingress Connection resource that's updated by this request.
 








Class com.amazonaws.services.apprunner.model.VpcConnector extends Object implements Serializable


Serialized Fields


vpcConnectorName
String vpcConnectorName

 The customer-provided VPC connector name.
 


vpcConnectorArn
String vpcConnectorArn

 The Amazon Resource Name (ARN) of this VPC connector.
 


vpcConnectorRevision
Integer vpcConnectorRevision

 The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE")
 that share the same Name.
 
 
 
 At this time, App Runner supports only one revision per name.
 
 


subnets
List<E> subnets

 A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.
 


securityGroups
List<E> securityGroups

 A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the
 specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default
 security group allows all outbound traffic.
 


status
String status

 The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was
 deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.
 


createdAt
Date createdAt

 The time when the VPC connector was created. It's in Unix time stamp format.
 


deletedAt
Date deletedAt

 The time when the VPC connector was deleted. It's in Unix time stamp format.
 








Class com.amazonaws.services.apprunner.model.VpcDNSTarget extends Object implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.
 


vpcId
String vpcId

 The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.
 


domainName
String domainName

 The domain name of your target DNS that is associated with the Amazon VPC.
 








Class com.amazonaws.services.apprunner.model.VpcIngressConnection extends Object implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (ARN) of the VPC Ingress Connection.
 


vpcIngressConnectionName
String vpcIngressConnectionName

 The customer-provided VPC Ingress Connection name.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
 


status
String status

 The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following
 statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE,
 PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE,
 FAILED_DELETION, and DELETED..
 


accountId
String accountId

 The Account Id you use to create the VPC Ingress Connection resource.
 


domainName
String domainName

 The domain name associated with the VPC Ingress Connection resource.
 


ingressVpcConfiguration
IngressVpcConfiguration ingressVpcConfiguration

 Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the
 VPC Ingress Connection resource.
 


createdAt
Date createdAt

 The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
 
 
 
 
 Type: Timestamp
 
 
 
 
 Required: Yes
 
 
 


deletedAt
Date deletedAt

 The time when the App Runner service was deleted. It's in the Unix time stamp format.
 
 
 
 
 Type: Timestamp
 
 
 
 
 Required: No
 
 
 








Class com.amazonaws.services.apprunner.model.VpcIngressConnectionSummary extends Object implements Serializable


Serialized Fields


vpcIngressConnectionArn
String vpcIngressConnectionArn

 The Amazon Resource Name (ARN) of the VPC Ingress Connection.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.
 








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.AppBlock extends Object implements Serializable


Serialized Fields


name
String name

 The name of the app block.
 


arn
String arn

 The ARN of the app block.
 


description
String description

 The description of the app block.
 


displayName
String displayName

 The display name of the app block.
 


sourceS3Location
S3Location sourceS3Location

 The source S3 location of the app block.
 


setupScriptDetails
ScriptDetails setupScriptDetails

 The setup script details of the app block.
 
 
 This only applies to app blocks with PackagingType CUSTOM.
 


createdTime
Date createdTime

 The created time of the app block.
 


postSetupScriptDetails
ScriptDetails postSetupScriptDetails

 The post setup script details of the app block.
 
 
 This only applies to app blocks with PackagingType APPSTREAM2.
 


packagingType
String packagingType

 The packaging type of the app block.
 


state
String state

 The state of the app block.
 
 
 An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package
 (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block,
 it becomes ACTIVE.
 
 
 Custom app blocks are always in the ACTIVE state and no action is required to use them.
 


appBlockErrors
List<E> appBlockErrors

 The errors of the app block.
 








Class com.amazonaws.services.appstream.model.AppBlockBuilder extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the app block builder.
 


name
String name

 The name of the app block builder.
 


displayName
String displayName

 The display name of the app block builder.
 


description
String description

 The description of the app block builder.
 


platform
String platform

 The platform of the app block builder.
 
 
 WINDOWS_SERVER_2019 is the only valid value.
 


instanceType
String instanceType

 The instance type of the app block builder.
 


enableDefaultInternetAccess
Boolean enableDefaultInternetAccess

 Indicates whether default internet access is enabled for the app block builder.
 


iamRoleArn
String iamRoleArn

 The ARN of the IAM role that is applied to the app block builder.
 


vpcConfig
VpcConfig vpcConfig

 The VPC configuration for the app block builder.
 


state
String state

 The state of the app block builder.
 


createdTime
Date createdTime

 The creation time of the app block builder.
 


appBlockBuilderErrors
List<E> appBlockBuilderErrors

 The app block builder errors.
 


stateChangeReason
AppBlockBuilderStateChangeReason stateChangeReason

 The state change reason.
 


accessEndpoints
List<E> accessEndpoints

 The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block
 builder only through the specified endpoints.
 








Class com.amazonaws.services.appstream.model.AppBlockBuilderAppBlockAssociation extends Object implements Serializable


Serialized Fields


appBlockArn
String appBlockArn

 The ARN of the app block.
 


appBlockBuilderName
String appBlockBuilderName

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.AppBlockBuilderStateChangeReason 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.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.
 


workingDirectory
String workingDirectory

 The working directory for the application.
 


description
String description

 The description of the application.
 


arn
String arn

 The ARN of the application.
 


appBlockArn
String appBlockArn

 The app block ARN of the application.
 


iconS3Location
S3Location iconS3Location

 The S3 location of the application icon.
 


platforms
List<E> platforms

 The platforms on which the application can run.
 


instanceFamilies
List<E> instanceFamilies

 The instance families for the application.
 


createdTime
Date createdTime

 The time at which the application was created within the app block.
 








Class com.amazonaws.services.appstream.model.ApplicationFleetAssociation extends Object implements Serializable


Serialized Fields


fleetName
String fleetName

 The name of the fleet associated with the application.
 


applicationArn
String applicationArn

 The ARN of the application associated with the fleet.
 








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.AssociateAppBlockBuilderAppBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBlockArn
String appBlockArn

 The ARN of the app block.
 


appBlockBuilderName
String appBlockBuilderName

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.AssociateAppBlockBuilderAppBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilderAppBlockAssociation
AppBlockBuilderAppBlockAssociation appBlockBuilderAppBlockAssociation

 The list of app block builders associated with app blocks.
 








Class com.amazonaws.services.appstream.model.AssociateApplicationFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetName
String fleetName

 The name of the fleet.
 


applicationArn
String applicationArn

 The ARN of the application.
 








Class com.amazonaws.services.appstream.model.AssociateApplicationFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationFleetAssociation
ApplicationFleetAssociation applicationFleetAssociation

 If fleet name is specified, this returns the list of applications that are associated to it. If application ARN
 is specified, this returns the list of fleets to which it is associated.
 








Class com.amazonaws.services.appstream.model.AssociateApplicationToEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack.
 


entitlementName
String entitlementName

 The name of the entitlement.
 


applicationIdentifier
String applicationIdentifier

 The identifier of the application.
 








Class com.amazonaws.services.appstream.model.AssociateApplicationToEntitlementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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.CertificateBasedAuthProperties extends Object implements Serializable


Serialized Fields


status
String status

 The status of the certificate-based authentication properties.
 


certificateAuthorityArn
String certificateAuthorityArn

 The ARN of the AWS Certificate Manager Private CA resource.
 








Class com.amazonaws.services.appstream.model.ComputeCapacity extends Object implements Serializable


Serialized Fields


desiredInstances
Integer desiredInstances

 The desired number of streaming instances.
 


desiredSessions
Integer desiredSessions

 The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
 
 
 When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type
 of fleet you create. You can’t define both attributes or leave both attributes blank.
 








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.
 


desiredUserSessions
Integer desiredUserSessions

 The total number of sessions slots that are either running or pending. This represents the total number of
 concurrent streaming sessions your fleet can support in a steady state.
 
 
 DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
 
 
 This only applies to multi-session fleets.
 


availableUserSessions
Integer availableUserSessions

 The number of idle session slots currently available for user sessions.
 
 
 AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
 
 
 This only applies to multi-session fleets.
 


activeUserSessions
Integer activeUserSessions

 The number of user sessions currently being used for streaming sessions. This only applies to multi-session
 fleets.
 


actualUserSessions
Integer actualUserSessions

 The total number of session slots that are available for streaming or are currently streaming.
 
 
 ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
 
 
 This only applies to multi-session fleets.
 








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.CreateAppBlockBuilderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The unique name for the app block builder.
 


description
String description

 The description of the app block builder.
 


displayName
String displayName

 The display name of the app block builder.
 


tags
Map<K,V> tags

 The tags to associate with the app block 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=.
 
 
 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.
 


platform
String platform

 The platform of the app block builder.
 
 
 WINDOWS_SERVER_2019 is the only valid value.
 


instanceType
String instanceType

 The instance type to use when launching the app block builder. The following instance types are available:
 
 
 
 
 stream.standard.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 


vpcConfig
VpcConfig vpcConfig

 The VPC configuration for the app block builder.
 
 
 App block builders require that you specify at least two subnets in different availability zones.
 


enableDefaultInternetAccess
Boolean enableDefaultInternetAccess

 Enables or disables default internet access for the app block builder.
 


iamRoleArn
String iamRoleArn

 The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block
 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.
 


accessEndpoints
List<E> accessEndpoints

 The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block
 builder only through the specified endpoints.
 








Class com.amazonaws.services.appstream.model.CreateAppBlockBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilder
AppBlockBuilder appBlockBuilder








Class com.amazonaws.services.appstream.model.CreateAppBlockBuilderStreamingURLRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBlockBuilderName
String appBlockBuilderName

 The name of the app block 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.CreateAppBlockBuilderStreamingURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingURL
String streamingURL

 The URL to start the streaming session.
 


expires
Date expires

 The elapsed time, in seconds after the Unix epoch, when this URL expires.
 








Class com.amazonaws.services.appstream.model.CreateAppBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the app block.
 


description
String description

 The description of the app block.
 


displayName
String displayName

 The display name of the app block. This is not displayed to the user.
 


sourceS3Location
S3Location sourceS3Location

 The source S3 location of the app block.
 


setupScriptDetails
ScriptDetails setupScriptDetails

 The setup script details of the app block. This must be provided for the CUSTOM PackagingType.
 


tags
Map<K,V> tags

 The tags assigned to the app block.
 


postSetupScriptDetails
ScriptDetails postSetupScriptDetails

 The post setup script details of the app block. This can only be provided for the APPSTREAM2
 PackagingType.
 


packagingType
String packagingType

 The packaging type of the app block.
 








Class com.amazonaws.services.appstream.model.CreateAppBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlock
AppBlock appBlock

 The app block.
 








Class com.amazonaws.services.appstream.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the application. This name is visible to users when display name is not specified.
 


displayName
String displayName

 The display name of the application. This name is visible to users in the application catalog.
 


description
String description

 The description of the application.
 


iconS3Location
S3Location iconS3Location

 The location in S3 of the application icon.
 


launchPath
String launchPath

 The launch path of the application.
 


workingDirectory
String workingDirectory

 The working directory of the application.
 


launchParameters
String launchParameters

 The launch parameters of the application.
 


platforms
List<E> platforms

 The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
 


instanceFamilies
List<E> instanceFamilies

 The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
 


appBlockArn
String appBlockArn

 The app block ARN to which the application should be associated
 


tags
Map<K,V> tags

 The tags assigned to the application.
 








Class com.amazonaws.services.appstream.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
Application application








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.
 


certificateBasedAuthProperties
CertificateBasedAuthProperties certificateBasedAuthProperties

 The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
 identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
 certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
 password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
 Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to
 log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
 








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.CreateEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the entitlement.
 


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


description
String description

 The description of the entitlement.
 


appVisibility
String appVisibility

 Specifies whether all or selected apps are entitled.
 


attributes
List<E> attributes

 The attributes of the entitlement.
 








Class com.amazonaws.services.appstream.model.CreateEntitlementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlement
Entitlement entitlement

 The entitlement.
 








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.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 
 
 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.memory.z1d.large
 
 
 
 
 stream.memory.z1d.xlarge
 
 
 
 
 stream.memory.z1d.2xlarge
 
 
 
 
 stream.memory.z1d.3xlarge
 
 
 
 
 stream.memory.z1d.6xlarge
 
 
 
 
 stream.memory.z1d.12xlarge
 
 
 
 
 stream.graphics-design.large
 
 
 
 
 stream.graphics-design.xlarge
 
 
 
 
 stream.graphics-design.2xlarge
 
 
 
 
 stream.graphics-design.4xlarge
 
 
 
 
 stream.graphics-desktop.2xlarge
 
 
 
 
 stream.graphics.g4dn.xlarge
 
 
 
 
 stream.graphics.g4dn.2xlarge
 
 
 
 
 stream.graphics.g4dn.4xlarge
 
 
 
 
 stream.graphics.g4dn.8xlarge
 
 
 
 
 stream.graphics.g4dn.12xlarge
 
 
 
 
 stream.graphics.g4dn.16xlarge
 
 
 
 
 stream.graphics-pro.4xlarge
 
 
 
 
 stream.graphics-pro.8xlarge
 
 
 
 
 stream.graphics-pro.16xlarge
 
 
 
 
 The following instance types are available for Elastic fleets:
 
 
 
 
 stream.standard.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 


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. This is not allowed for Elastic fleets. For Elastic fleets, specify
 MaxConcurrentSessions instead.
 


vpcConfig
VpcConfig vpcConfig

 The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.
 Elastic fleets require that you specify at least two subnets in different availability zones.
 


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


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


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. This is not allowed for Elastic fleets.
 


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


streamView
String streamView

 The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is
 specified, only the windows of applications opened by users display. When DESKTOP is specified, the
 standard desktop that is provided by the operating system displays.
 
 
 The default value is APP.
 


platform
String platform

 The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
 


maxConcurrentSessions
Integer maxConcurrentSessions

 The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for
 other fleet types.
 


usbDeviceFilterStrings
List<E> usbDeviceFilterStrings

 The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session,
 when using the Windows native client. This is allowed but not required for Elastic fleets.
 


sessionScriptS3Location
S3Location sessionScriptS3Location

 The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
 


maxSessionsPerInstance
Integer maxSessionsPerInstance

 The maximum number of user sessions on an instance. This only applies to multi-session fleets.
 








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.small
 
 
 
 
 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.memory.z1d.large
 
 
 
 
 stream.memory.z1d.xlarge
 
 
 
 
 stream.memory.z1d.2xlarge
 
 
 
 
 stream.memory.z1d.3xlarge
 
 
 
 
 stream.memory.z1d.6xlarge
 
 
 
 
 stream.memory.z1d.12xlarge
 
 
 
 
 stream.graphics-design.large
 
 
 
 
 stream.graphics-design.xlarge
 
 
 
 
 stream.graphics-design.2xlarge
 
 
 
 
 stream.graphics-design.4xlarge
 
 
 
 
 stream.graphics-desktop.2xlarge
 
 
 
 
 stream.graphics.g4dn.xlarge
 
 
 
 
 stream.graphics.g4dn.2xlarge
 
 
 
 
 stream.graphics.g4dn.4xlarge
 
 
 
 
 stream.graphics.g4dn.8xlarge
 
 
 
 
 stream.graphics.g4dn.12xlarge
 
 
 
 
 stream.graphics.g4dn.16xlarge
 
 
 
 
 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.
 


streamingExperienceSettings
StreamingExperienceSettings streamingExperienceSettings

 The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in
 the Windows native client.
 








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. If your fleet is enabled for the Desktop stream view, you can also
 choose to launch directly to the operating system desktop. To do so, specify Desktop.
 


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.CreateUpdatedImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


existingImageName
String existingImageName

 The name of the image to update.
 


newImageName
String newImageName

 The name of the new image. The name must be unique within the AWS account and Region.
 


newImageDescription
String newImageDescription

 The description to display for the new image.
 


newImageDisplayName
String newImageDisplayName

 The name to display for the new image.
 


newImageTags
Map<K,V> newImageTags

 The tags to associate with the new image. 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.
 


dryRun
Boolean dryRun

 Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process
 of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image
 updates are available. If this value is set to false, AppStream 2.0 initiates the process of
 creating a new updated image without displaying whether image updates are available.
 








Class com.amazonaws.services.appstream.model.CreateUpdatedImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


image
Image image


canUpdateImage
Boolean canUpdateImage

 Indicates whether a new image can be created.
 








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.DeleteAppBlockBuilderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.DeleteAppBlockBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appstream.model.DeleteAppBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the app block.
 








Class com.amazonaws.services.appstream.model.DeleteAppBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appstream.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the application.
 








Class com.amazonaws.services.appstream.model.DeleteApplicationResult 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.DeleteEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the entitlement.
 


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 








Class com.amazonaws.services.appstream.model.DeleteEntitlementResult 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.DescribeAppBlockBuilderAppBlockAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBlockArn
String appBlockArn

 The ARN of the app block.
 


appBlockBuilderName
String appBlockBuilderName

 The name of the app block builder.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeAppBlockBuilderAppBlockAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilderAppBlockAssociations
List<E> appBlockBuilderAppBlockAssociations

 This list of app block builders associated with app blocks.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeAppBlockBuildersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 The names of the app block builders.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 


maxResults
Integer maxResults

 The maximum size of each page of results. The maximum value is 25.
 








Class com.amazonaws.services.appstream.model.DescribeAppBlockBuildersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilders
List<E> appBlockBuilders

 The list that describes one or more app block builders.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeAppBlocksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arns
List<E> arns

 The ARNs of the app blocks.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 








Class com.amazonaws.services.appstream.model.DescribeAppBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlocks
List<E> appBlocks

 The app blocks in the list.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeApplicationFleetAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetName
String fleetName

 The name of the fleet.
 


applicationArn
String applicationArn

 The ARN of the application.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeApplicationFleetAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationFleetAssociations
List<E> applicationFleetAssociations

 The application fleet associations in the list.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








Class com.amazonaws.services.appstream.model.DescribeApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arns
List<E> arns

 The ARNs for the applications.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 








Class com.amazonaws.services.appstream.model.DescribeApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applications
List<E> applications

 The applications in the list.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








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.DescribeEntitlementsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the entitlement.
 


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 








Class com.amazonaws.services.appstream.model.DescribeEntitlementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlements
List<E> entitlements

 The entitlements.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








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 (ID). If you specify a user ID, you must also specify the authentication type.
 


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.
 


instanceId
String instanceId

 The identifier for the instance hosting the session.
 








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.
 


certificateBasedAuthProperties
CertificateBasedAuthProperties certificateBasedAuthProperties

 The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
 identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
 certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
 password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
 Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to
 log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
 








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.DisassociateAppBlockBuilderAppBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appBlockArn
String appBlockArn

 The ARN of the app block.
 


appBlockBuilderName
String appBlockBuilderName

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.DisassociateAppBlockBuilderAppBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appstream.model.DisassociateApplicationFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetName
String fleetName

 The name of the fleet.
 


applicationArn
String applicationArn

 The ARN of the application.
 








Class com.amazonaws.services.appstream.model.DisassociateApplicationFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appstream.model.DisassociateApplicationFromEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


entitlementName
String entitlementName

 The name of the entitlement.
 


applicationIdentifier
String applicationIdentifier

 The identifier of the application to remove from the entitlement.
 








Class com.amazonaws.services.appstream.model.DisassociateApplicationFromEntitlementResult 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.EntitledApplication extends Object implements Serializable


Serialized Fields


applicationIdentifier
String applicationIdentifier

 The identifier of the application.
 








Class com.amazonaws.services.appstream.model.Entitlement extends Object implements Serializable


Serialized Fields


name
String name

 The name of the entitlement.
 


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


description
String description

 The description of the entitlement.
 


appVisibility
String appVisibility

 Specifies whether all or selected apps are entitled.
 


attributes
List<E> attributes

 The attributes of the entitlement.
 


createdTime
Date createdTime

 The time when the entitlement was created.
 


lastModifiedTime
Date lastModifiedTime

 The time when the entitlement was last modified.
 








Class com.amazonaws.services.appstream.model.EntitlementAlreadyExistsException extends AmazonAppStreamException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appstream.model.EntitlementAttribute extends Object implements Serializable


Serialized Fields


name
String name

 A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user
 identity federates into an Amazon AppStream 2.0 SAML application.
 
 
 The following are valid values:
 
 
 
 
 roles
 
 
 
 
 department
 
 
 
 
 organization
 
 
 
 
 groups
 
 
 
 
 title
 
 
 
 
 costCenter
 
 
 
 
 userType
 
 
 
 
 


value
String value

 A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon
 AppStream 2.0 SAML application.
 








Class com.amazonaws.services.appstream.model.EntitlementNotFoundException extends AmazonAppStreamException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.appstream.model.ErrorDetails extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The error code.
 


errorMessage
String errorMessage

 The error message.
 








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.small
 
 
 
 
 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.memory.z1d.large
 
 
 
 
 stream.memory.z1d.xlarge
 
 
 
 
 stream.memory.z1d.2xlarge
 
 
 
 
 stream.memory.z1d.3xlarge
 
 
 
 
 stream.memory.z1d.6xlarge
 
 
 
 
 stream.memory.z1d.12xlarge
 
 
 
 
 stream.graphics-design.large
 
 
 
 
 stream.graphics-design.xlarge
 
 
 
 
 stream.graphics-design.2xlarge
 
 
 
 
 stream.graphics-design.4xlarge
 
 
 
 
 stream.graphics-desktop.2xlarge
 
 
 
 
 stream.graphics.g4dn.xlarge
 
 
 
 
 stream.graphics.g4dn.2xlarge
 
 
 
 
 stream.graphics.g4dn.4xlarge
 
 
 
 
 stream.graphics.g4dn.8xlarge
 
 
 
 
 stream.graphics.g4dn.12xlarge
 
 
 
 
 stream.graphics.g4dn.16xlarge
 
 
 
 
 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 36000.
 


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


streamView
String streamView

 The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is
 specified, only the windows of applications opened by users display. When DESKTOP is specified, the
 standard desktop that is provided by the operating system displays.
 
 
 The default value is APP.
 


platform
String platform

 The platform of the fleet.
 


maxConcurrentSessions
Integer maxConcurrentSessions

 The maximum number of concurrent sessions for the fleet.
 


usbDeviceFilterStrings
List<E> usbDeviceFilterStrings

 The USB device filter strings associated with the fleet.
 


sessionScriptS3Location
S3Location sessionScriptS3Location

 The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
 


maxSessionsPerInstance
Integer maxSessionsPerInstance

 The maximum number of user sessions on an instance. This only applies to multi-session fleets.
 








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.
 


imageErrors
List<E> imageErrors

 Describes the errors that are returned when a new image can't be created.
 








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.small
 
 
 
 
 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.memory.z1d.large
 
 
 
 
 stream.memory.z1d.xlarge
 
 
 
 
 stream.memory.z1d.2xlarge
 
 
 
 
 stream.memory.z1d.3xlarge
 
 
 
 
 stream.memory.z1d.6xlarge
 
 
 
 
 stream.memory.z1d.12xlarge
 
 
 
 
 stream.graphics-design.large
 
 
 
 
 stream.graphics-design.xlarge
 
 
 
 
 stream.graphics-design.2xlarge
 
 
 
 
 stream.graphics-design.4xlarge
 
 
 
 
 stream.graphics-desktop.2xlarge
 
 
 
 
 stream.graphics.g4dn.xlarge
 
 
 
 
 stream.graphics.g4dn.2xlarge
 
 
 
 
 stream.graphics.g4dn.4xlarge
 
 
 
 
 stream.graphics.g4dn.8xlarge
 
 
 
 
 stream.graphics.g4dn.12xlarge
 
 
 
 
 stream.graphics.g4dn.16xlarge
 
 
 
 
 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.ListEntitledApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


entitlementName
String entitlementName

 The name of the entitlement.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 


maxResults
Integer maxResults

 The maximum size of each page of results.
 








Class com.amazonaws.services.appstream.model.ListEntitledApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitledApplications
List<E> entitledApplications

 The entitled applications.
 


nextToken
String nextToken

 The pagination token used to retrieve the next page of results for this operation.
 








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.RequestLimitExceededException 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.S3Location extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The S3 bucket of the S3 object.
 


s3Key
String s3Key

 The S3 key of the S3 object.
 
 
 This is required when used for the following:
 
 
 
 
 IconS3Location (Actions: CreateApplication and UpdateApplication)
 
 
 
 
 SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
 
 
 
 
 ScriptDetails (Actions: CreateAppBlock)
 
 
 
 
 SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)
 
 
 
 
 SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing
 application package (VHD file). In this case, S3Key refers to the VHD file. If a new application
 package is required, then S3Key is not required. (Actions: CreateAppBlock)
 
 
 








Class com.amazonaws.services.appstream.model.ScriptDetails extends Object implements Serializable


Serialized Fields


scriptS3Location
S3Location scriptS3Location

 The S3 object location for the script.
 


executablePath
String executablePath

 The run path for the script.
 


executableParameters
String executableParameters

 The runtime parameters passed to the run path for the script.
 


timeoutInSeconds
Integer timeoutInSeconds

 The run timeout, in seconds, for the script.
 








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.
 


instanceId
String instanceId

 The identifier for the instance hosting the 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.
 


streamingExperienceSettings
StreamingExperienceSettings streamingExperienceSettings

 The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in
 the Windows native client.
 








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.StartAppBlockBuilderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.StartAppBlockBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilder
AppBlockBuilder appBlockBuilder








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.StopAppBlockBuilderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the app block builder.
 








Class com.amazonaws.services.appstream.model.StopAppBlockBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilder
AppBlockBuilder appBlockBuilder








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.StreamingExperienceSettings extends Object implements Serializable


Serialized Fields


preferredProtocol
String preferredProtocol

 The preferred protocol that you want to use while streaming your application.
 








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.UpdateAppBlockBuilderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The unique name for the app block builder.
 


description
String description

 The description of the app block builder.
 


displayName
String displayName

 The display name of the app block builder.
 


platform
String platform

 The platform of the app block builder.
 
 
 WINDOWS_SERVER_2019 is the only valid value.
 


instanceType
String instanceType

 The instance type to use when launching the app block builder. The following instance types are available:
 
 
 
 
 stream.standard.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 


vpcConfig
VpcConfig vpcConfig

 The VPC configuration for the app block builder.
 
 
 App block builders require that you specify at least two subnets in different availability zones.
 


enableDefaultInternetAccess
Boolean enableDefaultInternetAccess

 Enables or disables default internet access for the app block builder.
 


iamRoleArn
String iamRoleArn

 The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block
 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.
 


accessEndpoints
List<E> accessEndpoints

 The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block
 builder only through the specified endpoints.
 


attributesToDelete
List<E> attributesToDelete

 The attributes to delete from the app block builder.
 








Class com.amazonaws.services.appstream.model.UpdateAppBlockBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appBlockBuilder
AppBlockBuilder appBlockBuilder








Class com.amazonaws.services.appstream.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the application. This name is visible to users when display name is not specified.
 


displayName
String displayName

 The display name of the application. This name is visible to users in the application catalog.
 


description
String description

 The description of the application.
 


iconS3Location
S3Location iconS3Location

 The icon S3 location of the application.
 


launchPath
String launchPath

 The launch path of the application.
 


workingDirectory
String workingDirectory

 The working directory of the application.
 


launchParameters
String launchParameters

 The launch parameters of the application.
 


appBlockArn
String appBlockArn

 The ARN of the app block.
 


attributesToDelete
List<E> attributesToDelete

 The attributes to delete for an application.
 








Class com.amazonaws.services.appstream.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
Application application








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.
 


certificateBasedAuthProperties
CertificateBasedAuthProperties certificateBasedAuthProperties

 The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user
 identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when
 certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain
 password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen.
 Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to
 log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
 








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.UpdateEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the entitlement.
 


stackName
String stackName

 The name of the stack with which the entitlement is associated.
 


description
String description

 The description of the entitlement.
 


appVisibility
String appVisibility

 Specifies whether all or only selected apps are entitled.
 


attributes
List<E> attributes

 The attributes of the entitlement.
 








Class com.amazonaws.services.appstream.model.UpdateEntitlementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlement
Entitlement entitlement

 The entitlement.
 








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.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 
 
 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.memory.z1d.large
 
 
 
 
 stream.memory.z1d.xlarge
 
 
 
 
 stream.memory.z1d.2xlarge
 
 
 
 
 stream.memory.z1d.3xlarge
 
 
 
 
 stream.memory.z1d.6xlarge
 
 
 
 
 stream.memory.z1d.12xlarge
 
 
 
 
 stream.graphics-design.large
 
 
 
 
 stream.graphics-design.xlarge
 
 
 
 
 stream.graphics-design.2xlarge
 
 
 
 
 stream.graphics-design.4xlarge
 
 
 
 
 stream.graphics-desktop.2xlarge
 
 
 
 
 stream.graphics.g4dn.xlarge
 
 
 
 
 stream.graphics.g4dn.2xlarge
 
 
 
 
 stream.graphics.g4dn.4xlarge
 
 
 
 
 stream.graphics.g4dn.8xlarge
 
 
 
 
 stream.graphics.g4dn.12xlarge
 
 
 
 
 stream.graphics.g4dn.16xlarge
 
 
 
 
 stream.graphics-pro.4xlarge
 
 
 
 
 stream.graphics-pro.8xlarge
 
 
 
 
 stream.graphics-pro.16xlarge
 
 
 
 
 The following instance types are available for Elastic fleets:
 
 
 
 
 stream.standard.small
 
 
 
 
 stream.standard.medium
 
 
 
 
 stream.standard.large
 
 
 
 
 stream.standard.xlarge
 
 
 
 
 stream.standard.2xlarge
 
 
 


computeCapacity
ComputeCapacity computeCapacity

 The desired capacity for the fleet. This is not allowed for Elastic fleets.
 


vpcConfig
VpcConfig vpcConfig

 The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types.
 Elastic fleets require that you specify at least two subnets in different availability zones.
 


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


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


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


streamView
String streamView

 The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is
 specified, only the windows of applications opened by users display. When DESKTOP is specified, the
 standard desktop that is provided by the operating system displays.
 
 
 The default value is APP.
 


platform
String platform

 The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
 


maxConcurrentSessions
Integer maxConcurrentSessions

 The maximum number of concurrent sessions for a fleet.
 


usbDeviceFilterStrings
List<E> usbDeviceFilterStrings

 The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session,
 when using the Windows native client. This is allowed but not required for Elastic fleets.
 


sessionScriptS3Location
S3Location sessionScriptS3Location

 The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
 


maxSessionsPerInstance
Integer maxSessionsPerInstance

 The maximum number of user sessions on an instance. This only applies to multi-session fleets.
 








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.
 


streamingExperienceSettings
StreamingExperienceSettings streamingExperienceSettings

 The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in
 the Windows native client.
 








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.
 


maximumLength
Integer maximumLength

 Specifies the number of characters that can be copied by end users from the local device to the remote session,
 and to the local device from the remote session.
 
 
 This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and
 CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
 
 
 This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be
 specified when the permission is DISABLED.
 
 
 The value can be between 1 and 20,971,520 (20 MB).
 








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, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito
 user pools, or Lambda.
 


openIDConnectConfig
OpenIDConnectConfig openIDConnectConfig

 The OIDC configuration.
 


userPoolConfig
CognitoUserPoolConfig userPoolConfig

 The Amazon Cognito user pool configuration.
 


lambdaAuthorizerConfig
LambdaAuthorizerConfig lambdaAuthorizerConfig

 Configuration for Lambda function authorization.
 








Class com.amazonaws.services.appsync.model.ApiAssociation extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 


apiId
String apiId

 The API ID.
 


associationStatus
String associationStatus

 Identifies the status of an association.
 
 
 
 
 PROCESSING: The API association is being created. You cannot modify association requests during
 processing.
 
 
 
 
 SUCCESS: The API association was successful. You can modify associations after success.
 
 
 
 
 FAILED: The API association has failed. You can modify associations after failure.
 
 
 


deploymentDetail
String deploymentDetail

 Details about the last deployment status.
 








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 1–3,600 seconds.
 


apiCachingBehavior
String apiCachingBehavior

 Caching behavior.
 
 
 
 
 FULL_REQUEST_CACHING: All requests are fully cached.
 
 
 
 
 PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
 
 
 


transitEncryptionEnabled
Boolean transitEncryptionEnabled

 Transit encryption flag when connecting to cache. You cannot update this setting after creation.
 


atRestEncryptionEnabled
Boolean atRestEncryptionEnabled

 At-rest encryption flag for cache. You cannot update this setting after creation.
 


type
String type

 The cache instance type. Valid values are
 
 
 
 
 SMALL
 
 
 
 
 MEDIUM
 
 
 
 
 LARGE
 
 
 
 
 XLARGE
 
 
 
 
 LARGE_2X
 
 
 
 
 LARGE_4X
 
 
 
 
 LARGE_8X (not available in all regions)
 
 
 
 
 LARGE_12X
 
 
 
 
 Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the
 generic identifiers above should be used.
 
 
 The following legacy instance types are available, but their use is discouraged:
 
 
 
 
 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.
 
 
 


healthMetricsConfig
String healthMetricsConfig

 Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
 
 
 
 
 NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated
 bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
 
 
 
 
 EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for
 diagnosing bottlenecks in a cache configuration.
 
 
 
 
 Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.
 








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.
 


deletes
Long deletes

 The time after which the API key is deleted. 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.AppSyncRuntime extends Object implements Serializable


Serialized Fields


name
String name

 The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
 


runtimeVersion
String runtimeVersion

 The version of the runtime to use. Currently, the only allowed version is 1.0.0.
 








Class com.amazonaws.services.appsync.model.AssociateApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 


apiId
String apiId

 The API ID. Private APIs can not be associated with custom domains.
 








Class com.amazonaws.services.appsync.model.AssociateApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


apiAssociation
ApiAssociation apiAssociation

 The ApiAssociation object.
 








Class com.amazonaws.services.appsync.model.AssociateMergedGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceApiIdentifier
String sourceApiIdentifier

 The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs
 (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from
 other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
 


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


description
String description

 The description field.
 


sourceApiAssociationConfig
SourceApiAssociationConfig sourceApiAssociationConfig

 The SourceApiAssociationConfig object data.
 








Class com.amazonaws.services.appsync.model.AssociateMergedGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociation
SourceApiAssociation sourceApiAssociation

 The SourceApiAssociation object data.
 








Class com.amazonaws.services.appsync.model.AssociateSourceGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


sourceApiIdentifier
String sourceApiIdentifier

 The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs
 (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from
 other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
 


description
String description

 The description field.
 


sourceApiAssociationConfig
SourceApiAssociationConfig sourceApiAssociationConfig

 The SourceApiAssociationConfig object data.
 








Class com.amazonaws.services.appsync.model.AssociateSourceGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociation
SourceApiAssociation sourceApiAssociation

 The SourceApiAssociation object data.
 








Class com.amazonaws.services.appsync.model.AuthorizationConfig extends Object implements Serializable


Serialized Fields


authorizationType
String authorizationType

 The authorization type that the HTTP endpoint requires.
 
 
 
 
 AWS_IAM: The authorization type is Signature Version 4 (SigV4).
 
 
 


awsIamConfig
AwsIamConfig awsIamConfig

 The Identity and Access Management (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 Amazon Web Services Region for IAM authorization.
 


signingServiceName
String signingServiceName

 The signing service name for IAM authorization.
 








Class com.amazonaws.services.appsync.model.BadRequestDetail extends Object implements Serializable


Serialized Fields


codeErrors
List<E> codeErrors

 Contains the list of errors in the request.
 








Class com.amazonaws.services.appsync.model.BadRequestException extends AWSAppSyncException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason


detail
BadRequestDetail detail








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 activated.
 
 
 Valid values are 1–3,600 seconds.
 


cachingKeys
List<E> cachingKeys

 The caching keys for a resolver that has caching activated.
 
 
 Valid values are entries from the $context.arguments, $context.source, and
 $context.identity maps.
 








Class com.amazonaws.services.appsync.model.CodeError extends Object implements Serializable


Serialized Fields


errorType
String errorType

 The type of code error.
 
 
 Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
 


value
String value

 A user presentable error.
 
 
 Examples include, but aren't limited to: Parsing error: Unterminated string literal.
 


location
CodeErrorLocation location

 The line, column, and span location of the error in the code.
 








Class com.amazonaws.services.appsync.model.CodeErrorLocation extends Object implements Serializable


Serialized Fields


line
Integer line

 The line number in the code. Defaults to 0 if unknown.
 


column
Integer column

 The column number in the code. Defaults to 0 if unknown.
 


span
Integer span

 The span/length of the error. Defaults to -1 if unknown.
 








Class com.amazonaws.services.appsync.model.CognitoUserPoolConfig extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


awsRegion
String awsRegion

 The Amazon Web Services 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. If this value isn't set,
 no filtering is applied.
 








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 1–3,600 seconds.
 


transitEncryptionEnabled
Boolean transitEncryptionEnabled

 Transit encryption flag when connecting to cache. You cannot update this setting after creation.
 


atRestEncryptionEnabled
Boolean atRestEncryptionEnabled

 At-rest encryption flag for cache. You cannot update this setting after creation.
 


apiCachingBehavior
String apiCachingBehavior

 Caching behavior.
 
 
 
 
 FULL_REQUEST_CACHING: All requests are fully cached.
 
 
 
 
 PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
 
 
 


type
String type

 The cache instance type. Valid values are
 
 
 
 
 SMALL
 
 
 
 
 MEDIUM
 
 
 
 
 LARGE
 
 
 
 
 XLARGE
 
 
 
 
 LARGE_2X
 
 
 
 
 LARGE_4X
 
 
 
 
 LARGE_8X (not available in all regions)
 
 
 
 
 LARGE_12X
 
 
 
 
 Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the
 generic identifiers above should be used.
 
 
 The following legacy instance types are available, but their use is discouraged:
 
 
 
 
 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.
 
 
 


healthMetricsConfig
String healthMetricsConfig

 Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
 
 
 
 
 NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated
 bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
 
 
 
 
 EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for
 diagnosing bottlenecks in a cache configuration.
 
 
 
 
 Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.
 








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

 From the creation time, the 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 Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system
 assumes this role when accessing the data source.
 


dynamodbConfig
DynamodbDataSourceConfig dynamodbConfig

 Amazon DynamoDB settings.
 


lambdaConfig
LambdaDataSourceConfig lambdaConfig

 Lambda settings.
 


elasticsearchConfig
ElasticsearchDataSourceConfig elasticsearchConfig

 Amazon OpenSearch Service settings.
 
 
 As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
 deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an
 OpenSearch data source.
 


openSearchServiceConfig
OpenSearchServiceDataSourceConfig openSearchServiceConfig

 Amazon OpenSearch Service settings.
 


httpConfig
HttpDataSourceConfig httpConfig

 HTTP endpoint settings.
 


relationalDatabaseConfig
RelationalDatabaseDataSourceConfig relationalDatabaseConfig

 Relational database settings.
 


eventBridgeConfig
EventBridgeDataSourceConfig eventBridgeConfig

 Amazon EventBridge settings.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig
 won't be used unless the dataSourceLevelMetricsBehavior value is set to
 PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
 FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you
 can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








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.CreateDomainNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an
 Identity and Access Management (IAM) server certificate.
 


description
String description

 A description of the DomainName.
 








Class com.amazonaws.services.appsync.model.CreateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNameConfig
DomainNameConfig domainNameConfig

 The configuration for the DomainName.
 








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. Note that
 when using VTL and mapping templates, the functionVersion is required.
 


syncConfig
SyncConfig syncConfig


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The function code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 








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, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito
 user pools, or Lambda.
 


userPoolConfig
UserPoolConfig userPoolConfig

 The Amazon Cognito user pool configuration.
 


openIDConnectConfig
OpenIDConnectConfig openIDConnectConfig

 The OIDC configuration.
 


tags
Map<K,V> tags

 A TagMap object.
 


additionalAuthenticationProviders
List<E> additionalAuthenticationProviders

 A list of additional authentication providers for the GraphqlApi API.
 


xrayEnabled
Boolean xrayEnabled

 A flag indicating whether to use X-Ray tracing for the GraphqlApi.
 


lambdaAuthorizerConfig
LambdaAuthorizerConfig lambdaAuthorizerConfig

 Configuration for Lambda function authorization.
 


visibility
String visibility

 Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value
 is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the
 API has been created.
 


apiType
String apiType

 The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (
 MERGED).
 


mergedApiExecutionRoleArn
String mergedApiExecutionRoleArn

 The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
 behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
 to update the merged API endpoint with the source API changes automatically.
 


ownerContact
String ownerContact

 The owner contact information for an API resource.
 
 
 This field accepts any string input with a length of 0 - 256 characters.
 


introspectionConfig
String introspectionConfig

 Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
 introspection. If no value is provided, the introspection configuration will be set to ENABLED by
 default. This field will produce an error if the operation attempts to use the introspection feature while this
 field is disabled.
 
 
 For more information about introspection, see GraphQL
 introspection.
 


queryDepthLimit
Integer queryDepthLimit

 The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in
 the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit.
 If you set a limit, it can be between 1 and 75 nested levels. This field will produce a
 limit error if the operation falls out of bounds.
 
 
 Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the
 error will be thrown upwards to the first nullable field available.
 


resolverCountLimit
Integer resolverCountLimit

 The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or
 unspecified), which will set the limit to 10000. When specified, the limit value can be between
 1 and 10000. This field will produce a limit error if the operation falls out of
 bounds.
 


enhancedMetricsConfig
EnhancedMetricsConfig enhancedMetricsConfig

 The enhancedMetricsConfig object.
 








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 use 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).
 
 
 VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL
 request and response mapping templates are required.
 


responseMappingTemplate
String responseMappingTemplate

 The mapping template to use 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. You can use a UNIT resolver to
 run a GraphQL query against a single data source.
 
 
 
 
 PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of
 Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against
 multiple data sources.
 
 
 


pipelineConfig
PipelineConfig pipelineConfig

 The PipelineConfig.
 


syncConfig
SyncConfig syncConfig

 The SyncConfig for a resolver attached to a versioned data source.
 


cachingConfig
CachingConfig cachingConfig

 The caching configuration for the resolver.
 


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The resolver code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't
 be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS.
 If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead,
 metricsConfig will be ignored. However, you can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








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 Amazon Resource Name (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.
 
 
 
 
 AWS_LAMBDA: The data source is an Lambda function.
 
 
 
 
 AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
 
 
 
 
 AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.
 
 
 
 
 AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
 
 
 
 
 AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.
 
 
 
 
 NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without
 connecting to a data source, such as when you're performing data transformation with resolvers or invoking a
 subscription from a mutation.
 
 
 
 
 HTTP: The data source is an HTTP endpoint.
 
 
 
 
 RELATIONAL_DATABASE: The data source is a relational database.
 
 
 


serviceRoleArn
String serviceRoleArn

 The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system
 assumes this role when accessing the data source.
 


dynamodbConfig
DynamodbDataSourceConfig dynamodbConfig

 DynamoDB settings.
 


lambdaConfig
LambdaDataSourceConfig lambdaConfig

 Lambda settings.
 


elasticsearchConfig
ElasticsearchDataSourceConfig elasticsearchConfig

 Amazon OpenSearch Service settings.
 


openSearchServiceConfig
OpenSearchServiceDataSourceConfig openSearchServiceConfig

 Amazon OpenSearch Service settings.
 


httpConfig
HttpDataSourceConfig httpConfig

 HTTP endpoint settings.
 


relationalDatabaseConfig
RelationalDatabaseDataSourceConfig relationalDatabaseConfig

 Relational database settings.
 


eventBridgeConfig
EventBridgeDataSourceConfig eventBridgeConfig

 Amazon EventBridge settings.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig
 won't be used unless the dataSourceLevelMetricsBehavior value is set to
 PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
 FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you
 can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








Class com.amazonaws.services.appsync.model.DataSourceIntrospectionModel extends Object implements Serializable


Serialized Fields


name
String name

 The name of the model. For example, this could be the name of a single table in a database.
 


fields
List<E> fields

 The DataSourceIntrospectionModelField object data.
 


primaryKey
DataSourceIntrospectionModelIndex primaryKey

 The primary key stored as a DataSourceIntrospectionModelIndex object.
 


indexes
List<E> indexes

 The array of DataSourceIntrospectionModelIndex objects.
 


sdl
String sdl

 Contains the output of the SDL that was generated from the introspected types. This is controlled by the
 includeModelsSDL parameter of the GetDataSourceIntrospection operation.
 








Class com.amazonaws.services.appsync.model.DataSourceIntrospectionModelField extends Object implements Serializable


Serialized Fields


name
String name

 The name of the field that was retrieved from the introspected data.
 


type
DataSourceIntrospectionModelFieldType type

 The DataSourceIntrospectionModelFieldType object data.
 


length
Long length

 The length value of the introspected field.
 








Class com.amazonaws.services.appsync.model.DataSourceIntrospectionModelFieldType extends Object implements Serializable


Serialized Fields


kind
String kind

 Specifies the classification of data. For example, this could be set to values like Scalar or
 NonNull to indicate a fundamental property of the field.
 
 
 Valid values include:
 
 
 
 
 Scalar: Indicates the value is a primitive type (scalar).
 
 
 
 
 NonNull: Indicates the field cannot be null.
 
 
 
 
 List: Indicates the field contains a list.
 
 
 


name
String name

 The name of the data type that represents the field. For example, String is a valid
 name value.
 


type
DataSourceIntrospectionModelFieldType type

 The DataSourceIntrospectionModelFieldType object data. The type is only present if
 DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
 
 
 The type typically contains its own kind and name fields to represent the
 actual type data. For instance, type could contain a kind value of Scalar
 with a name value of String. The values Scalar and String
 will be collectively stored in the values field.
 


values
List<E> values

 The values of the type field. This field represents the AppSync data type equivalent of the
 introspected field.
 








Class com.amazonaws.services.appsync.model.DataSourceIntrospectionModelIndex extends Object implements Serializable


Serialized Fields


name
String name

 The name of the index.
 


fields
List<E> fields

 The fields of the index.
 








Class com.amazonaws.services.appsync.model.DataSourceIntrospectionResult extends Object implements Serializable


Serialized Fields


models
List<E> models

 The array of DataSourceIntrospectionModel objects.
 


nextToken
String nextToken

 Determines the number of types to be returned in a single response before paginating. This value is typically
 taken from nextToken value from the previous response.
 








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.DeleteDomainNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 








Class com.amazonaws.services.appsync.model.DeleteDomainNameResult 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 that an Item is stored in the data source.
 


deltaSyncTableName
String deltaSyncTableName

 The Delta Sync table name.
 


deltaSyncTableTTL
Long deltaSyncTableTTL

 The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
 








Class com.amazonaws.services.appsync.model.DisassociateApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 








Class com.amazonaws.services.appsync.model.DisassociateApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.appsync.model.DisassociateMergedGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceApiIdentifier
String sourceApiIdentifier

 The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs
 (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from
 other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
 


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 








Class com.amazonaws.services.appsync.model.DisassociateMergedGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociationStatus
String sourceApiAssociationStatus

 The state of the source API association.
 








Class com.amazonaws.services.appsync.model.DisassociateSourceGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 








Class com.amazonaws.services.appsync.model.DisassociateSourceGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociationStatus
String sourceApiAssociationStatus

 The state of the source API association.
 








Class com.amazonaws.services.appsync.model.DomainNameConfig extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 


description
String description

 A description of the DomainName configuration.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an
 Identity and Access Management (IAM) server certificate.
 


appsyncDomainName
String appsyncDomainName

 The domain name that AppSync provides.
 


hostedZoneId
String hostedZoneId

 The ID of your Amazon Route 53 hosted zone.
 








Class com.amazonaws.services.appsync.model.DynamodbDataSourceConfig extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The table name.
 


awsRegion
String awsRegion

 The Amazon Web Services Region.
 


useCallerCredentials
Boolean useCallerCredentials

 Set to TRUE to use Amazon Cognito credentials with this data source.
 


deltaSyncConfig
DeltaSyncConfig deltaSyncConfig

 The DeltaSyncConfig for a versioned data source.
 


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 Amazon Web Services Region.
 








Class com.amazonaws.services.appsync.model.EnhancedMetricsConfig extends Object implements Serializable


Serialized Fields


resolverLevelMetricsBehavior
String resolverLevelMetricsBehavior

 Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
 
 
 
 
 GraphQL errors: The number of GraphQL errors that occurred.
 
 
 
 
 Requests: The number of invocations that occurred during a request.
 
 
 
 
 Latency: The time to complete a resolver invocation.
 
 
 
 
 Cache hits: The number of cache hits during a request.
 
 
 
 
 Cache misses: The number of cache misses during a request.
 
 
 
 
 These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be
 recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a
 time:
 
 
 
 
 FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.
 
 
 
 
 PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the
 metricsConfig value set to ENABLED.
 
 
 


dataSourceLevelMetricsBehavior
String dataSourceLevelMetricsBehavior

 Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
 
 
 
 
 Requests: The number of invocations that occured during a request.
 
 
 
 
 Latency: The time to complete a data source invocation.
 
 
 
 
 Errors: The number of errors that occurred during a data source invocation.
 
 
 
 
 These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will
 be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these
 values at a time:
 
 
 
 
 FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.
 
 
 
 
 PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the
 metricsConfig value set to ENABLED.
 
 
 


operationLevelMetricsConfig
String operationLevelMetricsConfig

 Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
 
 
 
 
 Requests: The number of times a specified GraphQL operation was called.
 
 
 
 
 GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
 
 
 
 
 Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or
 DISABLED.
 








Class com.amazonaws.services.appsync.model.ErrorDetail extends Object implements Serializable


Serialized Fields


message
String message

 The error payload.
 








Class com.amazonaws.services.appsync.model.EvaluateCodeErrorDetail extends Object implements Serializable


Serialized Fields


message
String message

 The error payload.
 


codeErrors
List<E> codeErrors

 Contains the list of CodeError objects.
 








Class com.amazonaws.services.appsync.model.EvaluateCodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


runtime
AppSyncRuntime runtime

 The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is
 supported.
 


code
String code

 The code definition to be evaluated. Note that code and runtime are both required for
 this action. The runtime value must be APPSYNC_JS.
 


context
String context

 The map that holds all of the contextual information for your resolver invocation. A context is
 required for this action.
 


function
String function

 The function within the code to be evaluated. If provided, the valid values are request and
 response.
 








Class com.amazonaws.services.appsync.model.EvaluateCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResult
String evaluationResult

 The result of the evaluation operation.
 


error
EvaluateCodeErrorDetail error

 Contains the payload of the response error.
 


logs
List<E> logs

 A list of logs that were generated by calls to util.log.info and util.log.error in the
 evaluated code.
 








Class com.amazonaws.services.appsync.model.EvaluateMappingTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


template
String template

 The mapping template; this can be a request or response template. A template is required for this
 action.
 


context
String context

 The map that holds all of the contextual information for your resolver invocation. A context is
 required for this action.
 








Class com.amazonaws.services.appsync.model.EvaluateMappingTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResult
String evaluationResult

 The mapping template; this can be a request or response template.
 


error
ErrorDetail error

 The ErrorDetail object.
 


logs
List<E> logs

 A list of logs that were generated by calls to util.log.info and util.log.error in the
 evaluated code.
 








Class com.amazonaws.services.appsync.model.EventBridgeDataSourceConfig extends Object implements Serializable


Serialized Fields


eventBusArn
String eventBusArn

 The ARN of the event bus. For more information about event buses, see Amazon EventBridge event
 buses.
 








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 Amazon Resource Name (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.
 


syncConfig
SyncConfig syncConfig


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The function code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 








Class com.amazonaws.services.appsync.model.GetApiAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 








Class com.amazonaws.services.appsync.model.GetApiAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


apiAssociation
ApiAssociation apiAssociation

 The ApiAssociation object.
 








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

 The ApiCache object.
 








Class com.amazonaws.services.appsync.model.GetDataSourceIntrospectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


introspectionId
String introspectionId

 The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection
 record.
 


includeModelsSDL
Boolean includeModelsSDL

 A boolean flag that determines whether SDL should be generated for introspected types or not. If set to
 true, each model will contain an sdl property that contains the SDL for that type. The
 SDL only contains the type data and no additional metadata or directives.
 


nextToken
String nextToken

 Determines the number of types to be returned in a single response before paginating. This value is typically
 taken from nextToken value from the previous response.
 


maxResults
Integer maxResults

 The maximum number of introspected types that will be returned in a single response.
 








Class com.amazonaws.services.appsync.model.GetDataSourceIntrospectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


introspectionId
String introspectionId

 The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection
 record.
 


introspectionStatus
String introspectionStatus

 The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the
 status will be set to PROCESSING. Once the operation has been completed, the status will change to
 SUCCESS or FAILED depending on how the data was parsed. A FAILED operation
 will return an error and its details as an introspectionStatusDetail.
 


introspectionStatusDetail
String introspectionStatusDetail

 The error detail field. When a FAILED introspectionStatus is returned, the
 introspectionStatusDetail will also return the exact error that was generated during the operation.
 


introspectionResult
DataSourceIntrospectionResult introspectionResult

 The DataSourceIntrospectionResult object data.
 








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.GetDomainNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 








Class com.amazonaws.services.appsync.model.GetDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNameConfig
DomainNameConfig domainNameConfig

 The configuration for the DomainName.
 








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.GetGraphqlApiEnvironmentVariablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


apiId
String apiId

 The ID of the API from which the environmental variable list will be retrieved.
 








Class com.amazonaws.services.appsync.model.GetGraphqlApiEnvironmentVariablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentVariables
Map<K,V> environmentVariables

 The payload containing each environmental variable in the "key" : "value" format.
 








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.GetSourceApiAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 








Class com.amazonaws.services.appsync.model.GetSourceApiAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociation
SourceApiAssociation sourceApiAssociation

 The SourceApiAssociation object data.
 








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 Amazon Resource Name (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.
 


xrayEnabled
Boolean xrayEnabled

 A flag indicating whether to use X-Ray tracing for this GraphqlApi.
 


wafWebAclArn
String wafWebAclArn

 The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
 


lambdaAuthorizerConfig
LambdaAuthorizerConfig lambdaAuthorizerConfig

 Configuration for Lambda function authorization.
 


dns
Map<K,V> dns

 The DNS records for the API.
 


visibility
String visibility

 Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value
 is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the
 API has been created.
 


apiType
String apiType

 The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (
 MERGED).
 


mergedApiExecutionRoleArn
String mergedApiExecutionRoleArn

 The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
 behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
 to update the merged API endpoint with the source API changes automatically.
 


owner
String owner

 The account owner of the GraphQL API.
 


ownerContact
String ownerContact

 The owner contact information for an API resource.
 
 
 This field accepts any string input with a length of 0 - 256 characters.
 


introspectionConfig
String introspectionConfig

 Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
 introspection. If no value is provided, the introspection configuration will be set to ENABLED by
 default. This field will produce an error if the operation attempts to use the introspection feature while this
 field is disabled.
 
 
 For more information about introspection, see GraphQL
 introspection.
 


queryDepthLimit
Integer queryDepthLimit

 The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in
 the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit.
 If you set a limit, it can be between 1 and 75 nested levels. This field will produce a
 limit error if the operation falls out of bounds.
 
 
 Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the
 error will be thrown upwards to the first nullable field available.
 


resolverCountLimit
Integer resolverCountLimit

 The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or
 unspecified), which will set the limit to 10000. When specified, the limit value can be between
 1 and 10000. This field will produce a limit error if the operation falls out of
 bounds.
 


enhancedMetricsConfig
EnhancedMetricsConfig enhancedMetricsConfig

 The enhancedMetricsConfig object.
 








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 specify either the domain name or IP, and port combination, and the URL scheme
 must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and
 port 443 for HTTPS endpoints.
 


authorizationConfig
AuthorizationConfig authorizationConfig

 The authorization configuration 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.LambdaAuthorizerConfig extends Object implements Serializable


Serialized Fields


authorizerResultTtlInSeconds
Integer authorizerResultTtlInSeconds

 The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you
 don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value
 is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in
 its response.
 


authorizerUri
String authorizerUri

 The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard
 Lambda ARN, a version ARN (.../v3), or an alias ARN.
 
 
 Note: This Lambda function must have the following resource-based policy assigned to it. When configuring
 Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the
 following:
 
 
 aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
 


identityValidationExpression
String identityValidationExpression

 A regular expression for validation of tokens before the Lambda function is called.
 








Class com.amazonaws.services.appsync.model.LambdaConflictHandlerConfig extends Object implements Serializable


Serialized Fields


lambdaConflictHandlerArn
String lambdaConflictHandlerArn

 The Amazon Resource Name (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 Amazon Resource Name (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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that 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 pass 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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that 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 pass in the next request to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.appsync.model.ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 that you want the request to return.
 








Class com.amazonaws.services.appsync.model.ListDomainNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNameConfigs
List<E> domainNameConfigs

 Lists configurations for multiple domain names.
 


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.
 








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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that 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 you can use 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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that you want the request to return.
 


apiType
String apiType

 The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (
 MERGED).
 


owner
String owner

 The account owner of the GraphQL API.
 








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 pass 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 that 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 you can use 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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that 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 pass in the next request to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.appsync.model.ListSourceApiAssociationsRequest 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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that you want the request to return.
 








Class com.amazonaws.services.appsync.model.ListSourceApiAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociationSummaries
List<E> sourceApiAssociationSummaries

 The SourceApiAssociationSummary object data.
 


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.
 








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


Serialized Fields


resourceArn
String resourceArn

 The GraphqlApi Amazon Resource Name (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.ListTypesByAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 


format
String format

 The format type.
 


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 that you want the request to return.
 








Class com.amazonaws.services.appsync.model.ListTypesByAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


types
List<E> types

 The Type objects.
 


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.
 








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 you can use to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results that 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 pass 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 AppSync assumes to publish to 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 OIDC 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
 that AppSync can validate against multiple client identifiers at a time.
 


iatTTL
Long iatTTL

 The number of milliseconds that a token is valid after it's issued to a user.
 


authTTL
Long authTTL

 The number of milliseconds that a token is valid after being authenticated.
 








Class com.amazonaws.services.appsync.model.OpenSearchServiceDataSourceConfig extends Object implements Serializable


Serialized Fields


endpoint
String endpoint

 The endpoint.
 


awsRegion
String awsRegion

 The Amazon Web Services Region.
 








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.PutGraphqlApiEnvironmentVariablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


apiId
String apiId

 The ID of the API to which the environmental variable list will be written.
 


environmentVariables
Map<K,V> environmentVariables

 The list of environmental variables to add to the API.
 
 
 When creating an environmental variable key-value pair, it must follow the additional constraints below:
 
 
 
 
 Keys must begin with a letter.
 
 
 
 
 Keys must be at least two characters long.
 
 
 
 
 Keys can only contain letters, numbers, and the underscore character (_).
 
 
 
 
 Values can be up to 512 characters long.
 
 
 
 
 You can configure up to 50 key-value pairs in a GraphQL API.
 
 
 
 
 You can create a list of environmental variables by adding it to the environmentVariables payload as
 a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the
 PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing
 environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
 this, you must include all existing and new environmental variables in the list each time you call this action.
 








Class com.amazonaws.services.appsync.model.PutGraphqlApiEnvironmentVariablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentVariables
Map<K,V> environmentVariables

 The payload containing each environmental variable in the "key" : "value" format.
 








Class com.amazonaws.services.appsync.model.RdsDataApiConfig extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The resource ARN of the RDS cluster.
 


secretArn
String secretArn

 The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret
 value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,
 secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation
 data.
 


databaseName
String databaseName

 The name of the database in the cluster.
 








Class com.amazonaws.services.appsync.model.RdsHttpEndpointConfig extends Object implements Serializable


Serialized Fields


awsRegion
String awsRegion

 Amazon Web Services Region for Amazon RDS HTTP endpoint.
 


dbClusterIdentifier
String dbClusterIdentifier

 Amazon RDS cluster Amazon Resource Name (ARN).
 


databaseName
String databaseName

 Logical database name.
 


schema
String schema

 Logical schema name.
 


awsSecretStoreArn
String awsSecretStoreArn

 Amazon Web Services secret store Amazon Resource Name (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 Relational Database Service (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 Amazon Resource Name (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. You can use a UNIT resolver to
 run a GraphQL query against a single data source.
 
 
 
 
 PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of
 Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against
 multiple data sources.
 
 
 


pipelineConfig
PipelineConfig pipelineConfig

 The PipelineConfig.
 


syncConfig
SyncConfig syncConfig

 The SyncConfig for a resolver attached to a versioned data source.
 


cachingConfig
CachingConfig cachingConfig

 The caching configuration for the resolver.
 


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The resolver code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't
 be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS.
 If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead,
 metricsConfig will be ignored. However, you can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








Class com.amazonaws.services.appsync.model.SourceApiAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 


associationArn
String associationArn

 The Amazon Resource Name (ARN) of the source API association.
 


sourceApiId
String sourceApiId

 The ID of the AppSync source API.
 


sourceApiArn
String sourceApiArn

 The Amazon Resource Name (ARN) of the AppSync source API.
 


mergedApiArn
String mergedApiArn

 The Amazon Resource Name (ARN) of the AppSync Merged API.
 


mergedApiId
String mergedApiId

 The ID of the AppSync Merged API.
 


description
String description

 The description field.
 


sourceApiAssociationConfig
SourceApiAssociationConfig sourceApiAssociationConfig

 The SourceApiAssociationConfig object data.
 


sourceApiAssociationStatus
String sourceApiAssociationStatus

 The state of the source API association.
 


sourceApiAssociationStatusDetail
String sourceApiAssociationStatusDetail

 The detailed message related to the current state of the source API association.
 


lastSuccessfulMergeDate
Date lastSuccessfulMergeDate

 The datetime value of the last successful merge of the source API association. The result will be in UTC format
 and your local time zone.
 








Class com.amazonaws.services.appsync.model.SourceApiAssociationConfig extends Object implements Serializable


Serialized Fields


mergeType
String mergeType

 The property that indicates which merging option is enabled in the source API association.
 
 
 Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the
 default behavior and require the user to trigger any changes from the source APIs to the merged API manually.
 Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source
 APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge
 operations.
 








Class com.amazonaws.services.appsync.model.SourceApiAssociationSummary extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 


associationArn
String associationArn

 The Amazon Resource Name (ARN) of the source API association.
 


sourceApiId
String sourceApiId

 The ID of the AppSync source API.
 


sourceApiArn
String sourceApiArn

 The Amazon Resource Name (ARN) of the AppSync Source API.
 


mergedApiId
String mergedApiId

 The ID of the AppSync Merged API.
 


mergedApiArn
String mergedApiArn

 The Amazon Resource Name (ARN) of the AppSync Merged API.
 


description
String description

 The description field.
 








Class com.amazonaws.services.appsync.model.StartDataSourceIntrospectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rdsDataApiConfig
RdsDataApiConfig rdsDataApiConfig

 The rdsDataApiConfig object data.
 








Class com.amazonaws.services.appsync.model.StartDataSourceIntrospectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


introspectionId
String introspectionId

 The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection
 record.
 


introspectionStatus
String introspectionStatus

 The status of the introspection during creation. By default, when a new instrospection has been created, the
 status will be set to PROCESSING. Once the operation has been completed, the status will change to
 SUCCESS or FAILED depending on how the data was parsed. A FAILED operation
 will return an error and its details as an introspectionStatusDetail.
 


introspectionStatusDetail
String introspectionStatusDetail

 The error detail field. When a FAILED introspectionStatus is returned, the
 introspectionStatusDetail will also return the exact error that was generated during the operation.
 








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.StartSchemaMergeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 








Class com.amazonaws.services.appsync.model.StartSchemaMergeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociationStatus
String sourceApiAssociationStatus

 The state of the source API association.
 








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 don't match the latest
 version at the server.
 
 
 
 
 AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
 
 
 
 
 LAMBDA: Resolve conflicts with an 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 invoking 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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 1–3,600 seconds.
 


apiCachingBehavior
String apiCachingBehavior

 Caching behavior.
 
 
 
 
 FULL_REQUEST_CACHING: All requests are fully cached.
 
 
 
 
 PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
 
 
 


type
String type

 The cache instance type. Valid values are
 
 
 
 
 SMALL
 
 
 
 
 MEDIUM
 
 
 
 
 LARGE
 
 
 
 
 XLARGE
 
 
 
 
 LARGE_2X
 
 
 
 
 LARGE_4X
 
 
 
 
 LARGE_8X (not available in all regions)
 
 
 
 
 LARGE_12X
 
 
 
 
 Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the
 generic identifiers above should be used.
 
 
 The following legacy instance types are available, but their use is discouraged:
 
 
 
 
 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.
 
 
 


healthMetricsConfig
String healthMetricsConfig

 Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
 
 
 
 
 NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated
 bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
 
 
 
 
 EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for
 diagnosing bottlenecks in a cache configuration.
 
 
 
 
 Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED.
 








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

 From the update time, the 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 Amazon Resource Name (ARN) for the data source.
 


dynamodbConfig
DynamodbDataSourceConfig dynamodbConfig

 The new Amazon DynamoDB configuration.
 


lambdaConfig
LambdaDataSourceConfig lambdaConfig

 The new Lambda configuration.
 


elasticsearchConfig
ElasticsearchDataSourceConfig elasticsearchConfig

 The new OpenSearch configuration.
 
 
 As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
 deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data
 source.
 


openSearchServiceConfig
OpenSearchServiceDataSourceConfig openSearchServiceConfig

 The new OpenSearch configuration.
 


httpConfig
HttpDataSourceConfig httpConfig

 The new HTTP endpoint configuration.
 


relationalDatabaseConfig
RelationalDatabaseDataSourceConfig relationalDatabaseConfig

 The new relational database configuration.
 


eventBridgeConfig
EventBridgeDataSourceConfig eventBridgeConfig

 The new Amazon EventBridge settings.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig
 won't be used unless the dataSourceLevelMetricsBehavior value is set to
 PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to
 FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you
 can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








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.UpdateDomainNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name.
 


description
String description

 A description of the DomainName.
 








Class com.amazonaws.services.appsync.model.UpdateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNameConfig
DomainNameConfig domainNameConfig

 The configuration for the DomainName.
 








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. Note that
 when using VTL and mapping templates, the functionVersion is required.
 


syncConfig
SyncConfig syncConfig


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The function code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 








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.
 


xrayEnabled
Boolean xrayEnabled

 A flag indicating whether to use X-Ray tracing for the GraphqlApi.
 


lambdaAuthorizerConfig
LambdaAuthorizerConfig lambdaAuthorizerConfig

 Configuration for Lambda function authorization.
 


mergedApiExecutionRoleArn
String mergedApiExecutionRoleArn

 The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on
 behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE
 to update the merged API endpoint with the source API changes automatically.
 


ownerContact
String ownerContact

 The owner contact information for an API resource.
 
 
 This field accepts any string input with a length of 0 - 256 characters.
 


introspectionConfig
String introspectionConfig

 Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)
 introspection. If no value is provided, the introspection configuration will be set to ENABLED by
 default. This field will produce an error if the operation attempts to use the introspection feature while this
 field is disabled.
 
 
 For more information about introspection, see GraphQL
 introspection.
 


queryDepthLimit
Integer queryDepthLimit

 The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in
 the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit.
 If you set a limit, it can be between 1 and 75 nested levels. This field will produce a
 limit error if the operation falls out of bounds.
 
 
 Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the
 error will be thrown upwards to the first nullable field available.
 


resolverCountLimit
Integer resolverCountLimit

 The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or
 unspecified), which will set the limit to 10000. When specified, the limit value can be between
 1 and 10000. This field will produce a limit error if the operation falls out of
 bounds.
 


enhancedMetricsConfig
EnhancedMetricsConfig enhancedMetricsConfig

 The enhancedMetricsConfig object.
 








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.
 
 
 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).
 
 
 VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL
 request and response mapping templates are required.
 


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. You can use a UNIT resolver to
 run a GraphQL query against a single data source.
 
 
 
 
 PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of
 Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against
 multiple data sources.
 
 
 


pipelineConfig
PipelineConfig pipelineConfig

 The PipelineConfig.
 


syncConfig
SyncConfig syncConfig

 The SyncConfig for a resolver attached to a versioned data source.
 


cachingConfig
CachingConfig cachingConfig

 The caching configuration for the resolver.
 


maxBatchSize
Integer maxBatchSize

 The maximum batching size for a resolver.
 


runtime
AppSyncRuntime runtime


code
String code

 The resolver code that contains the request and response functions. When code is used, the
 runtime is required. The runtime value must be APPSYNC_JS.
 


metricsConfig
String metricsConfig

 Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig won't
 be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS.
 If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead,
 metricsConfig will be ignored. However, you can still set its value.
 
 
 metricsConfig can be ENABLED or DISABLED.
 








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.UpdateSourceApiAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID generated by the AppSync service for the source API association.
 


mergedApiIdentifier
String mergedApiIdentifier

 The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs
 (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in
 other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
 


description
String description

 The description field.
 


sourceApiAssociationConfig
SourceApiAssociationConfig sourceApiAssociationConfig

 The SourceApiAssociationConfig object data.
 








Class com.amazonaws.services.appsync.model.UpdateSourceApiAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceApiAssociation
SourceApiAssociation sourceApiAssociation

 The SourceApiAssociation object data.
 








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 Amazon Web Services 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. If this value isn't set,
 no filtering is applied.
 








Package com.amazonaws.services.apptest.model




Class com.amazonaws.services.apptest.model.AccessDeniedException extends AWSAppTestException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apptest.model.AWSAppTestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.apptest.model.Batch extends Object implements Serializable


Serialized Fields


batchJobName
String batchJobName

 The job name of the batch.
 


batchJobParameters
Map<K,V> batchJobParameters

 The batch job parameters of the batch.
 


exportDataSetNames
List<E> exportDataSetNames

 The export data set names of the batch.
 








Class com.amazonaws.services.apptest.model.BatchStepInput extends Object implements Serializable


Serialized Fields


resource
MainframeResourceSummary resource

 The resource of the batch step input.
 


batchJobName
String batchJobName

 The batch job name of the batch step input.
 


batchJobParameters

AWS SDK for Java 1.x API Reference - 1.12.787

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

proxyHost

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.Access extends Object implements Serializable

Serialized Fields

actions

resources

Class com.amazonaws.services.accessanalyzer.model.AccessDeniedException extends AWSAccessAnalyzerException implements Serializable

Class com.amazonaws.services.accessanalyzer.model.AccessPreview extends Object implements Serializable

Serialized Fields

id

analyzerArn

configurations

createdAt

status

statusReason

Class com.amazonaws.services.accessanalyzer.model.AccessPreviewFinding extends Object implements Serializable

Serialized Fields

id

existingFindingId

existingFindingStatus

principal

action

condition

resource

isPublic

resourceType

createdAt

changeType

status

resourceOwnerAccount

error

sources

Class com.amazonaws.services.accessanalyzer.model.AccessPreviewStatusReason extends Object implements Serializable

Serialized Fields

code

Class com.amazonaws.services.accessanalyzer.model.AccessPreviewSummary extends Object implements Serializable

Serialized Fields

id

analyzerArn