Package com.amazonaws.services.opensearch.model

Class Summary

Class	Description
AcceptInboundConnectionRequest	Container for the parameters to the AcceptInboundConnection operation.
AcceptInboundConnectionResult	The result of an AcceptInboundConnection operation.
AccessPoliciesStatus	The configured access rules for the domain's document and search endpoints, and the current status of those rules.
AdditionalLimit	List of limits that are specific to a given InstanceType and for each of its InstanceRole .
AddTagsRequest	Container for the parameters to the AddTags operation.
AddTagsResult
AdvancedOptionsStatus	Status of the advanced options for the specified domain.
AdvancedSecurityOptions	The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
AdvancedSecurityOptionsInput	The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
AdvancedSecurityOptionsStatus	The status of advanced security options for the specified domain.
AssociatePackageRequest	Container for the request parameters to the AssociatePackage operation.
AssociatePackageResult	Container for the response returned by AssociatePackage operation.
AutoTune	Specifies the Auto-Tune type and Auto-Tune action details.
AutoTuneDetails	Specifies details about the Auto-Tune action.
AutoTuneMaintenanceSchedule	Specifies the Auto-Tune maintenance schedule.
AutoTuneOptions	The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
AutoTuneOptionsInput	The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
AutoTuneOptionsOutput	The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
AutoTuneOptionsStatus	The Auto-Tune status for the domain.
AutoTuneStatus	Provides the current Auto-Tune status for the domain.
AWSDomainInformation
CancelServiceSoftwareUpdateRequest	Container for the parameters to the CancelServiceSoftwareUpdate operation.
CancelServiceSoftwareUpdateResult	The result of a CancelServiceSoftwareUpdate operation.
ChangeProgressDetails	Specifies change details of the domain configuration change.
ChangeProgressStage	A progress stage details of a specific domain configuration change.
ChangeProgressStatusDetails	The progress details of a specific domain configuration change.
ClusterConfig	The configuration for the domain cluster, such as the type and number of instances.
ClusterConfigStatus	The configuration status for the specified domain.
CognitoOptions	Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication.
CognitoOptionsStatus	The status of the Cognito options for the specified domain.
ColdStorageOptions	Specifies the configuration for cold storage options such as enabled
CompatibleVersionsMap	A map from an EngineVersion to a list of compatible EngineVersion s to which the domain can be upgraded.
CreateDomainRequest
CreateDomainResult	The result of a CreateDomain operation.
CreateOutboundConnectionRequest	Container for the parameters to the CreateOutboundConnection operation.
CreateOutboundConnectionResult	The result of a CreateOutboundConnection request.
CreatePackageRequest	Container for request parameters to the CreatePackage operation.
CreatePackageResult	Container for the response returned by the CreatePackage operation.
DeleteDomainRequest	Container for the parameters to the DeleteDomain operation.
DeleteDomainResult	The result of a DeleteDomain request.
DeleteInboundConnectionRequest	Container for the parameters to the DeleteInboundConnection operation.
DeleteInboundConnectionResult	The result of a DeleteInboundConnection operation.
DeleteOutboundConnectionRequest	Container for the parameters to the DeleteOutboundConnection operation.
DeleteOutboundConnectionResult	The result of a DeleteOutboundConnection operation.
DeletePackageRequest	Container for the request parameters to the DeletePackage operation.
DeletePackageResult	Container for the response parameters to the DeletePackage operation.
DescribeDomainAutoTunesRequest	Container for the parameters to the DescribeDomainAutoTunes operation.
DescribeDomainAutoTunesResult	The result of a DescribeDomainAutoTunes request.
DescribeDomainChangeProgressRequest	Container for the parameters to the DescribeDomainChangeProgress operation.
DescribeDomainChangeProgressResult	The result of a DescribeDomainChangeProgress request.
DescribeDomainConfigRequest	Container for the parameters to the DescribeDomainConfig operation.
DescribeDomainConfigResult	The result of a DescribeDomainConfig request.
DescribeDomainRequest	Container for the parameters to the DescribeDomain operation.
DescribeDomainResult	The result of a DescribeDomain request.
DescribeDomainsRequest	Container for the parameters to the DescribeDomains operation.
DescribeDomainsResult	The result of a DescribeDomains request.
DescribeInboundConnectionsRequest	Container for the parameters to the DescribeInboundConnections operation.
DescribeInboundConnectionsResult	The result of a DescribeInboundConnections request.
DescribeInstanceTypeLimitsRequest	Container for the parameters to the DescribeInstanceTypeLimits operation.
DescribeInstanceTypeLimitsResult	Container for the parameters received from the DescribeInstanceTypeLimits operation.
DescribeOutboundConnectionsRequest	Container for the parameters to the DescribeOutboundConnections operation.
DescribeOutboundConnectionsResult	The result of a DescribeOutboundConnections request.
DescribePackagesFilter	A filter to apply to the DescribePackage response.
DescribePackagesRequest	Container for the request parameters to the DescribePackage operation.
DescribePackagesResult	Container for the response returned by the DescribePackages operation.
DescribeReservedInstanceOfferingsRequest	Container for parameters to DescribeReservedInstanceOfferings
DescribeReservedInstanceOfferingsResult	Container for results from DescribeReservedInstanceOfferings
DescribeReservedInstancesRequest	Container for parameters to DescribeReservedInstances
DescribeReservedInstancesResult	Container for results from DescribeReservedInstances
DissociatePackageRequest	Container for the request parameters to the DissociatePackage operation.
DissociatePackageResult	Container for the response returned by DissociatePackage operation.
DomainConfig	The configuration of a domain.
DomainEndpointOptions	Options to configure the endpoint for the domain.
DomainEndpointOptionsStatus	The configured endpoint options for the domain and their current status.
DomainInfo
DomainInformationContainer
DomainPackageDetails	Information on a package associated with a domain.
DomainStatus	The current status of a domain.
DryRunResults
Duration	The maintenance schedule duration: duration value and duration unit.
EBSOptions	Options to enable, disable, and specify the properties of EBS storage volumes.
EBSOptionsStatus	Status of the EBS options for the specified domain.
EncryptionAtRestOptions	Specifies encryption at rest options.
EncryptionAtRestOptionsStatus	Status of the encryption At Rest options for the specified domain.
ErrorDetails
Filter	A filter used to limit results when describing inbound or outbound cross-cluster connections.
GetCompatibleVersionsRequest	Container for the request parameters to GetCompatibleVersions operation.
GetCompatibleVersionsResult	Container for the response returned by the GetCompatibleVersions operation.
GetPackageVersionHistoryRequest	Container for the request parameters to the GetPackageVersionHistory operation.
GetPackageVersionHistoryResult	Container for response returned by GetPackageVersionHistory operation.
GetUpgradeHistoryRequest	Container for the request parameters to the GetUpgradeHistory operation.
GetUpgradeHistoryResult	Container for the response returned by the GetUpgradeHistory operation.
GetUpgradeStatusRequest	Container for the request parameters to the GetUpgradeStatus operation.
GetUpgradeStatusResult	Container for the response returned by the GetUpgradeStatus operation.
InboundConnection	Details of an inbound connection.
InboundConnectionStatus	The connection status of an inbound cross-cluster connection.
InstanceCountLimits	InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.
InstanceLimits	InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.
InstanceTypeDetails
Limits	Limits for a given InstanceType and for each of its roles.
ListDomainNamesRequest	Container for the parameters to the ListDomainNames operation.
ListDomainNamesResult	The result of a ListDomainNames operation.
ListDomainsForPackageRequest	Container for the request parameters to the ListDomainsForPackage operation.
ListDomainsForPackageResult	Container for the response parameters to the ListDomainsForPackage operation.
ListInstanceTypeDetailsRequest
ListInstanceTypeDetailsResult
ListPackagesForDomainRequest	Container for the request parameters to the ListPackagesForDomain operation.
ListPackagesForDomainResult	Container for the response parameters to the ListPackagesForDomain operation.
ListTagsRequest	Container for the parameters to the ListTags operation.
ListTagsResult	The result of a ListTags operation.
ListVersionsRequest	Container for the parameters to the ListVersions operation.
ListVersionsResult	Container for the parameters for response received from the ListVersions operation.
LogPublishingOption	Log Publishing option that is set for a given domain.
LogPublishingOptionsStatus	The configured log publishing options for the domain and their current status.
MasterUserOptions	Credentials for the master user: username and password, ARN, or both.
NodeToNodeEncryptionOptions	The node-to-node encryption options.
NodeToNodeEncryptionOptionsStatus	Status of the node-to-node encryption options for the specified domain.
OptionStatus	Provides the current status of the entity.
OutboundConnection	Specifies details about an outbound connection.
OutboundConnectionStatus	The connection status of an outbound cross-cluster connection.
PackageDetails	Basic information about a package.
PackageSource	The Amazon S3 location for importing the package specified as S3BucketName and S3Key
PackageVersionHistory	Details of a package version.
PurchaseReservedInstanceOfferingRequest	Container for parameters to PurchaseReservedInstanceOffering
PurchaseReservedInstanceOfferingResult	Represents the output of a PurchaseReservedInstanceOffering operation.
RecurringCharge	Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.
RejectInboundConnectionRequest	Container for the parameters to the RejectInboundConnection operation.
RejectInboundConnectionResult	The result of a RejectInboundConnection operation.
RemoveTagsRequest	Container for the parameters to the RemoveTags operation.
RemoveTagsResult
ReservedInstance	Details of a reserved OpenSearch instance.
ReservedInstanceOffering	Details of a reserved OpenSearch instance offering.
SAMLIdp	The SAML identity povider's information.
SAMLOptionsInput	The SAML application configuration for the domain.
SAMLOptionsOutput	Describes the SAML application configured for the domain.
ScheduledAutoTuneDetails	Specifies details about the scheduled Auto-Tune action.
ServiceSoftwareOptions	The current options of an domain service software options.
SnapshotOptions	The time, in UTC format, when the service takes a daily automated snapshot of the specified domain.
SnapshotOptionsStatus	Status of a daily automated snapshot.
StartServiceSoftwareUpdateRequest	Container for the parameters to the StartServiceSoftwareUpdate operation.
StartServiceSoftwareUpdateResult	The result of a StartServiceSoftwareUpdate operation.
StorageType	StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.
StorageTypeLimit	Limits that are applicable for the given storage type.
Tag	A key value pair for a resource tag.
UpdateDomainConfigRequest	Container for the parameters to the UpdateDomain operation.
UpdateDomainConfigResult	The result of an UpdateDomain request.
UpdatePackageRequest	Container for request parameters to the UpdatePackage operation.
UpdatePackageResult	Container for the response returned by the UpdatePackage operation.
UpgradeDomainRequest	Container for the request parameters to UpgradeDomain operation.
UpgradeDomainResult	Container for response returned by UpgradeDomain operation.
UpgradeHistory	History of the last 10 upgrades and upgrade eligibility checks.
UpgradeStepItem	Represents a single step of the upgrade or upgrade eligibility check workflow.
VersionStatus	The status of the OpenSearch version options for the specified OpenSearch domain.
VPCDerivedInfo	Options to specify the subnets and security groups for the VPC endpoint.
VPCDerivedInfoStatus	Status of the VPC options for the specified domain.
VPCOptions	Options to specify the subnets and security groups for the VPC endpoint.
ZoneAwarenessConfig	The zone awareness configuration for the domain cluster, such as the number of availability zones.

Enum Summary

Enum	Description
AutoTuneDesiredState	The Auto-Tune desired state.
AutoTuneState	The Auto-Tune state for the domain.
AutoTuneType	Specifies the Auto-Tune type.
DeploymentStatus
DescribePackagesFilterName
DomainPackageStatus
EngineType
InboundConnectionStatusCode
LogType	Type of log file.
OpenSearchPartitionInstanceType
OpenSearchWarmPartitionInstanceType
OptionState	The state of a requested change.
OutboundConnectionStatusCode
OverallChangeStatus	The overall status value of the domain configuration change.
PackageStatus
PackageType
ReservedInstancePaymentOption
RollbackOnDisable	The rollback state while disabling Auto-Tune for the domain.
ScheduledAutoTuneActionType	The Auto-Tune action type.
ScheduledAutoTuneSeverityType	The Auto-Tune action severity.
TimeUnit	The unit of a maintenance schedule duration.
TLSSecurityPolicy
UpgradeStatus
UpgradeStep
VolumeType	The type of EBS volume, standard, gp2, or io1.

Exception Summary

Exception	Description
AccessDeniedException	An error occurred because user does not have permissions to access the resource.
AmazonOpenSearchException	Base exception for all service exceptions thrown by Amazon OpenSearch Service
BaseException	An error occurred while processing the request.
ConflictException	An error occurred because the client attempts to remove a resource that is currently in use.
DisabledOperationException	An error occured because the client wanted to access a not supported operation.
InternalException	The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) .
InvalidPaginationTokenException	The request processing has failed because of invalid pagination token provided by customer.
InvalidTypeException	An exception for trying to create or access sub-resource that is either invalid or not supported.
LimitExceededException	An exception for trying to create more than allowed resources or sub-resources.
ResourceAlreadyExistsException	An exception for creating a resource that already exists.
ResourceNotFoundException	An exception for accessing or deleting a resource that does not exist.
ValidationException	An exception for missing / invalid input fields.