func ActionSeverity_Values() []string
ActionSeverity_Values returns all elements of the ActionSeverity enum
func ActionStatus_Values() []string
ActionStatus_Values returns all elements of the ActionStatus enum
func ActionType_Values() []string
ActionType_Values returns all elements of the ActionType enum
func AutoTuneDesiredState_Values() []string
AutoTuneDesiredState_Values returns all elements of the AutoTuneDesiredState enum
func AutoTuneState_Values() []string
AutoTuneState_Values returns all elements of the AutoTuneState enum
func AutoTuneType_Values() []string
AutoTuneType_Values returns all elements of the AutoTuneType enum
func ConnectionMode_Values() []string
ConnectionMode_Values returns all elements of the ConnectionMode enum
func DeploymentStatus_Values() []string
DeploymentStatus_Values returns all elements of the DeploymentStatus enum
func DescribePackagesFilterName_Values() []string
DescribePackagesFilterName_Values returns all elements of the DescribePackagesFilterName enum
func DomainHealth_Values() []string
DomainHealth_Values returns all elements of the DomainHealth enum
func DomainPackageStatus_Values() []string
DomainPackageStatus_Values returns all elements of the DomainPackageStatus enum
func DomainState_Values() []string
DomainState_Values returns all elements of the DomainState enum
func DryRunMode_Values() []string
DryRunMode_Values returns all elements of the DryRunMode enum
func EngineType_Values() []string
EngineType_Values returns all elements of the EngineType enum
func InboundConnectionStatusCode_Values() []string
InboundConnectionStatusCode_Values returns all elements of the InboundConnectionStatusCode enum
func LogType_Values() []string
LogType_Values returns all elements of the LogType enum
func MasterNodeStatus_Values() []string
MasterNodeStatus_Values returns all elements of the MasterNodeStatus enum
func NodeStatus_Values() []string
NodeStatus_Values returns all elements of the NodeStatus enum
func NodeType_Values() []string
NodeType_Values returns all elements of the NodeType enum
func OpenSearchPartitionInstanceType_Values() []string
OpenSearchPartitionInstanceType_Values returns all elements of the OpenSearchPartitionInstanceType enum
func OpenSearchWarmPartitionInstanceType_Values() []string
OpenSearchWarmPartitionInstanceType_Values returns all elements of the OpenSearchWarmPartitionInstanceType enum
func OptionState_Values() []string
OptionState_Values returns all elements of the OptionState enum
func OutboundConnectionStatusCode_Values() []string
OutboundConnectionStatusCode_Values returns all elements of the OutboundConnectionStatusCode enum
func OverallChangeStatus_Values() []string
OverallChangeStatus_Values returns all elements of the OverallChangeStatus enum
func PackageStatus_Values() []string
PackageStatus_Values returns all elements of the PackageStatus enum
func PackageType_Values() []string
PackageType_Values returns all elements of the PackageType enum
func PrincipalType_Values() []string
PrincipalType_Values returns all elements of the PrincipalType enum
func ReservedInstancePaymentOption_Values() []string
ReservedInstancePaymentOption_Values returns all elements of the ReservedInstancePaymentOption enum
func RollbackOnDisable_Values() []string
RollbackOnDisable_Values returns all elements of the RollbackOnDisable enum
func ScheduleAt_Values() []string
ScheduleAt_Values returns all elements of the ScheduleAt enum
func ScheduledAutoTuneActionType_Values() []string
ScheduledAutoTuneActionType_Values returns all elements of the ScheduledAutoTuneActionType enum
func ScheduledAutoTuneSeverityType_Values() []string
ScheduledAutoTuneSeverityType_Values returns all elements of the ScheduledAutoTuneSeverityType enum
func ScheduledBy_Values() []string
ScheduledBy_Values returns all elements of the ScheduledBy enum
func TLSSecurityPolicy_Values() []string
TLSSecurityPolicy_Values returns all elements of the TLSSecurityPolicy enum
func TimeUnit_Values() []string
TimeUnit_Values returns all elements of the TimeUnit enum
func UpgradeStatus_Values() []string
UpgradeStatus_Values returns all elements of the UpgradeStatus enum
func UpgradeStep_Values() []string
UpgradeStep_Values returns all elements of the UpgradeStep enum
func VolumeType_Values() []string
VolumeType_Values returns all elements of the VolumeType enum
func VpcEndpointErrorCode_Values() []string
VpcEndpointErrorCode_Values returns all elements of the VpcEndpointErrorCode enum
func VpcEndpointStatus_Values() []string
VpcEndpointStatus_Values returns all elements of the VpcEndpointStatus enum
func ZoneStatus_Values() []string
ZoneStatus_Values returns all elements of the ZoneStatus enum
type AWSDomainInformation struct { // Name of the domain. // // DomainName is a required field DomainName *string `min:"3" type:"string" required:"true"` // The Amazon Web Services account ID of the domain owner. OwnerId *string `min:"12" type:"string"` // The Amazon Web Services Region in which the domain is located. Region *string `min:"5" type:"string"` // contains filtered or unexported fields }
Information about an Amazon OpenSearch Service domain.
func (s AWSDomainInformation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AWSDomainInformation) SetDomainName(v string) *AWSDomainInformation
SetDomainName sets the DomainName field's value.
func (s *AWSDomainInformation) SetOwnerId(v string) *AWSDomainInformation
SetOwnerId sets the OwnerId field's value.
func (s *AWSDomainInformation) SetRegion(v string) *AWSDomainInformation
SetRegion sets the Region field's value.
func (s AWSDomainInformation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AWSDomainInformation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AcceptInboundConnectionInput struct { // The ID of the inbound connection to accept. // // ConnectionId is a required field ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the AcceptInboundConnection operation.
func (s AcceptInboundConnectionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AcceptInboundConnectionInput) SetConnectionId(v string) *AcceptInboundConnectionInput
SetConnectionId sets the ConnectionId field's value.
func (s AcceptInboundConnectionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AcceptInboundConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AcceptInboundConnectionOutput struct { // Information about the accepted inbound connection. Connection *InboundConnection `type:"structure"` // contains filtered or unexported fields }
Contains details about the accepted inbound connection.
func (s AcceptInboundConnectionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AcceptInboundConnectionOutput) SetConnection(v *InboundConnection) *AcceptInboundConnectionOutput
SetConnection sets the Connection field's value.
func (s AcceptInboundConnectionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An error occurred because you don't have permissions to access the resource.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AccessPoliciesStatus struct { // The access policy configured for the domain. Access policies can be resource-based, // IP-based, or IAM-based. For more information, see Configuring access policies // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies). // // Options is a required field Options *string `type:"string" required:"true"` // The status of the access policy for the domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The configured access rules for the domain's search endpoint, and the current status of those rules.
func (s AccessPoliciesStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessPoliciesStatus) SetOptions(v string) *AccessPoliciesStatus
SetOptions sets the Options field's value.
func (s *AccessPoliciesStatus) SetStatus(v *OptionStatus) *AccessPoliciesStatus
SetStatus sets the Status field's value.
func (s AccessPoliciesStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AddTagsInput struct { // Amazon Resource Name (ARN) for the OpenSearch Service domain to which you // want to attach resource tags. // // ARN is a required field ARN *string `min:"20" type:"string" required:"true"` // List of resource tags. // // TagList is a required field TagList []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
func (s AddTagsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AddTagsInput) SetARN(v string) *AddTagsInput
SetARN sets the ARN field's value.
func (s *AddTagsInput) SetTagList(v []*Tag) *AddTagsInput
SetTagList sets the TagList field's value.
func (s AddTagsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AddTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsOutput struct {
// contains filtered or unexported fields
}
func (s AddTagsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s AddTagsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AdditionalLimit struct { // * MaximumNumberOfDataNodesSupported - This attribute only applies to master // nodes and specifies the maximum number of data nodes of a given instance // type a master node can support. // // * MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies // to data nodes and specifies the maximum number of data nodes of a given // instance type can exist without a master node governing them. LimitName *string `type:"string"` // The values of the additional instance type limits. LimitValues []*string `type:"list"` // contains filtered or unexported fields }
List of limits that are specific to a given instance type.
func (s AdditionalLimit) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdditionalLimit) SetLimitName(v string) *AdditionalLimit
SetLimitName sets the LimitName field's value.
func (s *AdditionalLimit) SetLimitValues(v []*string) *AdditionalLimit
SetLimitValues sets the LimitValues field's value.
func (s AdditionalLimit) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AdvancedOptionsStatus struct { // The status of advanced options for the specified domain. // // Options is a required field Options map[string]*string `type:"map" required:"true"` // The status of advanced options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
Status of the advanced options for the specified domain. The following options are available:
"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).
func (s AdvancedOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdvancedOptionsStatus) SetOptions(v map[string]*string) *AdvancedOptionsStatus
SetOptions sets the Options field's value.
func (s *AdvancedOptionsStatus) SetStatus(v *OptionStatus) *AdvancedOptionsStatus
SetStatus sets the Status field's value.
func (s AdvancedOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AdvancedSecurityOptions struct { // Date and time when the migration period will be disabled. Only necessary // when enabling fine-grained access control on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). AnonymousAuthDisableDate *time.Time `type:"timestamp"` // True if a 30-day migration period is enabled, during which administrators // can create role mappings. Only necessary when enabling fine-grained access // control on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). AnonymousAuthEnabled *bool `type:"boolean"` // True if fine-grained access control is enabled. Enabled *bool `type:"boolean"` // True if the internal user database is enabled. InternalUserDatabaseEnabled *bool `type:"boolean"` // Container for information about the SAML configuration for OpenSearch Dashboards. SAMLOptions *SAMLOptionsOutput_ `type:"structure"` // contains filtered or unexported fields }
Container for fine-grained access control settings.
func (s AdvancedSecurityOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdvancedSecurityOptions) SetAnonymousAuthDisableDate(v time.Time) *AdvancedSecurityOptions
SetAnonymousAuthDisableDate sets the AnonymousAuthDisableDate field's value.
func (s *AdvancedSecurityOptions) SetAnonymousAuthEnabled(v bool) *AdvancedSecurityOptions
SetAnonymousAuthEnabled sets the AnonymousAuthEnabled field's value.
func (s *AdvancedSecurityOptions) SetEnabled(v bool) *AdvancedSecurityOptions
SetEnabled sets the Enabled field's value.
func (s *AdvancedSecurityOptions) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptions
SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.
func (s *AdvancedSecurityOptions) SetSAMLOptions(v *SAMLOptionsOutput_) *AdvancedSecurityOptions
SetSAMLOptions sets the SAMLOptions field's value.
func (s AdvancedSecurityOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AdvancedSecurityOptionsInput_ struct { // True to enable a 30-day migration period during which administrators can // create role mappings. Only necessary when enabling fine-grained access control // on an existing domain (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing). AnonymousAuthEnabled *bool `type:"boolean"` // True to enable fine-grained access control. Enabled *bool `type:"boolean"` // True to enable the internal user database. InternalUserDatabaseEnabled *bool `type:"boolean"` // Container for information about the master user. MasterUserOptions *MasterUserOptions `type:"structure"` // Container for information about the SAML configuration for OpenSearch Dashboards. SAMLOptions *SAMLOptionsInput_ `type:"structure"` // contains filtered or unexported fields }
Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html).
func (s AdvancedSecurityOptionsInput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdvancedSecurityOptionsInput_) SetAnonymousAuthEnabled(v bool) *AdvancedSecurityOptionsInput_
SetAnonymousAuthEnabled sets the AnonymousAuthEnabled field's value.
func (s *AdvancedSecurityOptionsInput_) SetEnabled(v bool) *AdvancedSecurityOptionsInput_
SetEnabled sets the Enabled field's value.
func (s *AdvancedSecurityOptionsInput_) SetInternalUserDatabaseEnabled(v bool) *AdvancedSecurityOptionsInput_
SetInternalUserDatabaseEnabled sets the InternalUserDatabaseEnabled field's value.
func (s *AdvancedSecurityOptionsInput_) SetMasterUserOptions(v *MasterUserOptions) *AdvancedSecurityOptionsInput_
SetMasterUserOptions sets the MasterUserOptions field's value.
func (s *AdvancedSecurityOptionsInput_) SetSAMLOptions(v *SAMLOptionsInput_) *AdvancedSecurityOptionsInput_
SetSAMLOptions sets the SAMLOptions field's value.
func (s AdvancedSecurityOptionsInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdvancedSecurityOptionsInput_) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdvancedSecurityOptionsStatus struct { // Container for fine-grained access control settings. // // Options is a required field Options *AdvancedSecurityOptions `type:"structure" required:"true"` // Status of the fine-grained access control settings for a domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The status of fine-grained access control settings for a domain.
func (s AdvancedSecurityOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AdvancedSecurityOptionsStatus) SetOptions(v *AdvancedSecurityOptions) *AdvancedSecurityOptionsStatus
SetOptions sets the Options field's value.
func (s *AdvancedSecurityOptionsStatus) SetStatus(v *OptionStatus) *AdvancedSecurityOptionsStatus
SetStatus sets the Status field's value.
func (s AdvancedSecurityOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssociatePackageInput struct { // Name of the domain to associate the package with. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // Internal ID of the package to associate with a domain. Use DescribePackages // to find this value. // // PackageID is a required field PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to the AssociatePackage operation.
func (s AssociatePackageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociatePackageInput) SetDomainName(v string) *AssociatePackageInput
SetDomainName sets the DomainName field's value.
func (s *AssociatePackageInput) SetPackageID(v string) *AssociatePackageInput
SetPackageID sets the PackageID field's value.
func (s AssociatePackageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociatePackageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociatePackageOutput struct { // Information about a package that is associated with a domain. DomainPackageDetails *DomainPackageDetails `type:"structure"` // contains filtered or unexported fields }
Container for the response returned by the AssociatePackage operation.
func (s AssociatePackageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *AssociatePackageOutput
SetDomainPackageDetails sets the DomainPackageDetails field's value.
func (s AssociatePackageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AuthorizeVpcEndpointAccessInput struct { // The Amazon Web Services account ID to grant access to. // // Account is a required field Account *string `type:"string" required:"true"` // The name of the OpenSearch Service domain to provide access to. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
func (s AuthorizeVpcEndpointAccessInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthorizeVpcEndpointAccessInput) SetAccount(v string) *AuthorizeVpcEndpointAccessInput
SetAccount sets the Account field's value.
func (s *AuthorizeVpcEndpointAccessInput) SetDomainName(v string) *AuthorizeVpcEndpointAccessInput
SetDomainName sets the DomainName field's value.
func (s AuthorizeVpcEndpointAccessInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthorizeVpcEndpointAccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AuthorizeVpcEndpointAccessOutput struct { // Information about the Amazon Web Services account or service that was provided // access to the domain. // // AuthorizedPrincipal is a required field AuthorizedPrincipal *AuthorizedPrincipal `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s AuthorizeVpcEndpointAccessOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthorizeVpcEndpointAccessOutput) SetAuthorizedPrincipal(v *AuthorizedPrincipal) *AuthorizeVpcEndpointAccessOutput
SetAuthorizedPrincipal sets the AuthorizedPrincipal field's value.
func (s AuthorizeVpcEndpointAccessOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AuthorizedPrincipal struct { // The IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) // that is allowed access to the domain. Principal *string `type:"string"` // The type of principal. PrincipalType *string `type:"string" enum:"PrincipalType"` // contains filtered or unexported fields }
Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
func (s AuthorizedPrincipal) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AuthorizedPrincipal) SetPrincipal(v string) *AuthorizedPrincipal
SetPrincipal sets the Principal field's value.
func (s *AuthorizedPrincipal) SetPrincipalType(v string) *AuthorizedPrincipal
SetPrincipalType sets the PrincipalType field's value.
func (s AuthorizedPrincipal) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoTune struct { // Details about an Auto-Tune action. AutoTuneDetails *AutoTuneDetails `type:"structure"` // The type of Auto-Tune action. AutoTuneType *string `type:"string" enum:"AutoTuneType"` // contains filtered or unexported fields }
Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s AutoTune) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTune) SetAutoTuneDetails(v *AutoTuneDetails) *AutoTune
SetAutoTuneDetails sets the AutoTuneDetails field's value.
func (s *AutoTune) SetAutoTuneType(v string) *AutoTune
SetAutoTuneType sets the AutoTuneType field's value.
func (s AutoTune) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoTuneDetails struct { // Container for details about a scheduled Auto-Tune action. ScheduledAutoTuneDetails *ScheduledAutoTuneDetails `type:"structure"` // contains filtered or unexported fields }
Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s AutoTuneDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneDetails) SetScheduledAutoTuneDetails(v *ScheduledAutoTuneDetails) *AutoTuneDetails
SetScheduledAutoTuneDetails sets the ScheduledAutoTuneDetails field's value.
func (s AutoTuneDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoTuneMaintenanceSchedule struct { // A cron expression for a recurring maintenance schedule during which Auto-Tune // can deploy changes. CronExpressionForRecurrence *string `type:"string"` // The duration of the maintenance schedule. For example, "Duration": {"Value": // 2, "Unit": "HOURS"}. Duration *Duration `type:"structure"` // The Epoch timestamp at which the Auto-Tune maintenance schedule starts. StartAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
This object is deprecated. Use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate).
The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s AutoTuneMaintenanceSchedule) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneMaintenanceSchedule) SetCronExpressionForRecurrence(v string) *AutoTuneMaintenanceSchedule
SetCronExpressionForRecurrence sets the CronExpressionForRecurrence field's value.
func (s *AutoTuneMaintenanceSchedule) SetDuration(v *Duration) *AutoTuneMaintenanceSchedule
SetDuration sets the Duration field's value.
func (s *AutoTuneMaintenanceSchedule) SetStartAt(v time.Time) *AutoTuneMaintenanceSchedule
SetStartAt sets the StartAt field's value.
func (s AutoTuneMaintenanceSchedule) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneMaintenanceSchedule) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AutoTuneOptions struct { // Whether Auto-Tune is enabled or disabled. DesiredState *string `type:"string" enum:"AutoTuneDesiredState"` // DEPRECATED. Use off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) // instead. // // A list of maintenance schedules during which Auto-Tune can deploy changes. MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"` // When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune // settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. // If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in // the request. Otherwise, OpenSearch Service is unable to perform the rollback. RollbackOnDisable *string `type:"string" enum:"RollbackOnDisable"` // Whether to use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) // to deploy configuration changes on the domain rather than a maintenance schedule. UseOffPeakWindow *bool `type:"boolean"` // contains filtered or unexported fields }
Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s AutoTuneOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptions) SetDesiredState(v string) *AutoTuneOptions
SetDesiredState sets the DesiredState field's value.
func (s *AutoTuneOptions) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptions
SetMaintenanceSchedules sets the MaintenanceSchedules field's value.
func (s *AutoTuneOptions) SetRollbackOnDisable(v string) *AutoTuneOptions
SetRollbackOnDisable sets the RollbackOnDisable field's value.
func (s *AutoTuneOptions) SetUseOffPeakWindow(v bool) *AutoTuneOptions
SetUseOffPeakWindow sets the UseOffPeakWindow field's value.
func (s AutoTuneOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AutoTuneOptionsInput_ struct { // Whether Auto-Tune is enabled or disabled. DesiredState *string `type:"string" enum:"AutoTuneDesiredState"` // A list of maintenance schedules during which Auto-Tune can deploy changes. // Maintenance windows are deprecated and have been replaced with off-peak windows // (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html). MaintenanceSchedules []*AutoTuneMaintenanceSchedule `type:"list"` // Whether to schedule Auto-Tune optimizations that require blue/green deployments // during the domain's configured daily off-peak window. UseOffPeakWindow *bool `type:"boolean"` // contains filtered or unexported fields }
Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)
func (s AutoTuneOptionsInput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptionsInput_) SetDesiredState(v string) *AutoTuneOptionsInput_
SetDesiredState sets the DesiredState field's value.
func (s *AutoTuneOptionsInput_) SetMaintenanceSchedules(v []*AutoTuneMaintenanceSchedule) *AutoTuneOptionsInput_
SetMaintenanceSchedules sets the MaintenanceSchedules field's value.
func (s *AutoTuneOptionsInput_) SetUseOffPeakWindow(v bool) *AutoTuneOptionsInput_
SetUseOffPeakWindow sets the UseOffPeakWindow field's value.
func (s AutoTuneOptionsInput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptionsInput_) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AutoTuneOptionsOutput_ struct { // Any errors that occurred while enabling or disabling Auto-Tune. ErrorMessage *string `type:"string"` // The current state of Auto-Tune on the domain. State *string `type:"string" enum:"AutoTuneState"` // Whether the domain's off-peak window will be used to deploy Auto-Tune changes // rather than a maintenance schedule. UseOffPeakWindow *bool `type:"boolean"` // contains filtered or unexported fields }
The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
func (s AutoTuneOptionsOutput_) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptionsOutput_) SetErrorMessage(v string) *AutoTuneOptionsOutput_
SetErrorMessage sets the ErrorMessage field's value.
func (s *AutoTuneOptionsOutput_) SetState(v string) *AutoTuneOptionsOutput_
SetState sets the State field's value.
func (s *AutoTuneOptionsOutput_) SetUseOffPeakWindow(v bool) *AutoTuneOptionsOutput_
SetUseOffPeakWindow sets the UseOffPeakWindow field's value.
func (s AutoTuneOptionsOutput_) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoTuneOptionsStatus struct { // Auto-Tune settings for updating a domain. Options *AutoTuneOptions `type:"structure"` // The current status of Auto-Tune for a domain. Status *AutoTuneStatus `type:"structure"` // contains filtered or unexported fields }
The Auto-Tune status for the domain.
func (s AutoTuneOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneOptionsStatus) SetOptions(v *AutoTuneOptions) *AutoTuneOptionsStatus
SetOptions sets the Options field's value.
func (s *AutoTuneOptionsStatus) SetStatus(v *AutoTuneStatus) *AutoTuneOptionsStatus
SetStatus sets the Status field's value.
func (s AutoTuneOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AutoTuneStatus struct { // Date and time when Auto-Tune was enabled for the domain. // // CreationDate is a required field CreationDate *time.Time `type:"timestamp" required:"true"` // Any errors that occurred while enabling or disabling Auto-Tune. ErrorMessage *string `type:"string"` // Indicates whether the domain is being deleted. PendingDeletion *bool `type:"boolean"` // The current state of Auto-Tune on the domain. // // State is a required field State *string `type:"string" required:"true" enum:"AutoTuneState"` // Date and time when the Auto-Tune options were last updated for the domain. // // UpdateDate is a required field UpdateDate *time.Time `type:"timestamp" required:"true"` // The latest version of the Auto-Tune options. UpdateVersion *int64 `type:"integer"` // contains filtered or unexported fields }
The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s AutoTuneStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AutoTuneStatus) SetCreationDate(v time.Time) *AutoTuneStatus
SetCreationDate sets the CreationDate field's value.
func (s *AutoTuneStatus) SetErrorMessage(v string) *AutoTuneStatus
SetErrorMessage sets the ErrorMessage field's value.
func (s *AutoTuneStatus) SetPendingDeletion(v bool) *AutoTuneStatus
SetPendingDeletion sets the PendingDeletion field's value.
func (s *AutoTuneStatus) SetState(v string) *AutoTuneStatus
SetState sets the State field's value.
func (s *AutoTuneStatus) SetUpdateDate(v time.Time) *AutoTuneStatus
SetUpdateDate sets the UpdateDate field's value.
func (s *AutoTuneStatus) SetUpdateVersion(v int64) *AutoTuneStatus
SetUpdateVersion sets the UpdateVersion field's value.
func (s AutoTuneStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AvailabilityZoneInfo struct { // The name of the Availability Zone. AvailabilityZoneName *string `min:"1" type:"string"` // The number of data nodes active in the Availability Zone. AvailableDataNodeCount *string `type:"string"` // The total number of data nodes configured in the Availability Zone. ConfiguredDataNodeCount *string `type:"string"` // The total number of primary and replica shards in the Availability Zone. TotalShards *string `type:"string"` // The total number of primary and replica shards that aren't allocated to any // of the nodes in the Availability Zone. TotalUnAssignedShards *string `type:"string"` // The current state of the Availability Zone. Current options are Active and // StandBy. // // * Active - Data nodes in the Availability Zone are in use. // // * StandBy - Data nodes in the Availability Zone are in a standby state. // // * NotAvailable - Unable to retrieve information. ZoneStatus *string `type:"string" enum:"ZoneStatus"` // contains filtered or unexported fields }
Information about an Availability Zone on a domain.
func (s AvailabilityZoneInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AvailabilityZoneInfo) SetAvailabilityZoneName(v string) *AvailabilityZoneInfo
SetAvailabilityZoneName sets the AvailabilityZoneName field's value.
func (s *AvailabilityZoneInfo) SetAvailableDataNodeCount(v string) *AvailabilityZoneInfo
SetAvailableDataNodeCount sets the AvailableDataNodeCount field's value.
func (s *AvailabilityZoneInfo) SetConfiguredDataNodeCount(v string) *AvailabilityZoneInfo
SetConfiguredDataNodeCount sets the ConfiguredDataNodeCount field's value.
func (s *AvailabilityZoneInfo) SetTotalShards(v string) *AvailabilityZoneInfo
SetTotalShards sets the TotalShards field's value.
func (s *AvailabilityZoneInfo) SetTotalUnAssignedShards(v string) *AvailabilityZoneInfo
SetTotalUnAssignedShards sets the TotalUnAssignedShards field's value.
func (s *AvailabilityZoneInfo) SetZoneStatus(v string) *AvailabilityZoneInfo
SetZoneStatus sets the ZoneStatus field's value.
func (s AvailabilityZoneInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BaseException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // A description of the error. Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An error occurred while processing the request.
func (s *BaseException) Code() string
Code returns the exception type name.
func (s *BaseException) Error() string
func (s BaseException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BaseException) Message() string
Message returns the exception's message.
func (s *BaseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BaseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BaseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s BaseException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CancelServiceSoftwareUpdateInput struct { // Name of the OpenSearch Service domain that you want to cancel the service // software update on. // // DomainName is a required field DomainName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to cancel a service software update.
func (s CancelServiceSoftwareUpdateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelServiceSoftwareUpdateInput) SetDomainName(v string) *CancelServiceSoftwareUpdateInput
SetDomainName sets the DomainName field's value.
func (s CancelServiceSoftwareUpdateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelServiceSoftwareUpdateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelServiceSoftwareUpdateOutput struct { // Container for the state of your domain relative to the latest service software. ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"` // contains filtered or unexported fields }
Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.
func (s CancelServiceSoftwareUpdateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelServiceSoftwareUpdateOutput) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *CancelServiceSoftwareUpdateOutput
SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.
func (s CancelServiceSoftwareUpdateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeProgressDetails struct { // The ID of the configuration change. ChangeId *string `min:"36" type:"string"` // A message corresponding to the status of the configuration change. Message *string `type:"string"` // contains filtered or unexported fields }
Container for information about a configuration change happening on a domain.
func (s ChangeProgressDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChangeProgressDetails) SetChangeId(v string) *ChangeProgressDetails
SetChangeId sets the ChangeId field's value.
func (s *ChangeProgressDetails) SetMessage(v string) *ChangeProgressDetails
SetMessage sets the Message field's value.
func (s ChangeProgressDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeProgressStage struct { // The description of the stage. Description *string `type:"string"` // The most recent updated timestamp of the stage. LastUpdated *time.Time `type:"timestamp"` // The name of the stage. Name *string `min:"1" type:"string"` // The status of the stage. Status *string `min:"1" type:"string"` // contains filtered or unexported fields }
Progress details for each stage of a domain update.
func (s ChangeProgressStage) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChangeProgressStage) SetDescription(v string) *ChangeProgressStage
SetDescription sets the Description field's value.
func (s *ChangeProgressStage) SetLastUpdated(v time.Time) *ChangeProgressStage
SetLastUpdated sets the LastUpdated field's value.
func (s *ChangeProgressStage) SetName(v string) *ChangeProgressStage
SetName sets the Name field's value.
func (s *ChangeProgressStage) SetStatus(v string) *ChangeProgressStage
SetStatus sets the Status field's value.
func (s ChangeProgressStage) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChangeProgressStatusDetails struct { // The unique change identifier associated with a specific domain configuration // change. ChangeId *string `min:"36" type:"string"` // The specific stages that the domain is going through to perform the configuration // change. ChangeProgressStages []*ChangeProgressStage `type:"list"` // The list of properties in the domain configuration change that have completed. CompletedProperties []*string `type:"list"` // The list of properties in the domain configuration change that are still // pending. PendingProperties []*string `type:"list"` // The time at which the configuration change is made on the domain. StartTime *time.Time `type:"timestamp"` // The overall status of the domain configuration change. Status *string `type:"string" enum:"OverallChangeStatus"` // The total number of stages required for the configuration change. TotalNumberOfStages *int64 `type:"integer"` // contains filtered or unexported fields }
The progress details of a specific domain configuration change.
func (s ChangeProgressStatusDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChangeProgressStatusDetails) SetChangeId(v string) *ChangeProgressStatusDetails
SetChangeId sets the ChangeId field's value.
func (s *ChangeProgressStatusDetails) SetChangeProgressStages(v []*ChangeProgressStage) *ChangeProgressStatusDetails
SetChangeProgressStages sets the ChangeProgressStages field's value.
func (s *ChangeProgressStatusDetails) SetCompletedProperties(v []*string) *ChangeProgressStatusDetails
SetCompletedProperties sets the CompletedProperties field's value.
func (s *ChangeProgressStatusDetails) SetPendingProperties(v []*string) *ChangeProgressStatusDetails
SetPendingProperties sets the PendingProperties field's value.
func (s *ChangeProgressStatusDetails) SetStartTime(v time.Time) *ChangeProgressStatusDetails
SetStartTime sets the StartTime field's value.
func (s *ChangeProgressStatusDetails) SetStatus(v string) *ChangeProgressStatusDetails
SetStatus sets the Status field's value.
func (s *ChangeProgressStatusDetails) SetTotalNumberOfStages(v int64) *ChangeProgressStatusDetails
SetTotalNumberOfStages sets the TotalNumberOfStages field's value.
func (s ChangeProgressStatusDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClusterConfig struct { // Container for cold storage configuration options. ColdStorageOptions *ColdStorageOptions `type:"structure"` // Number of dedicated master nodes in the cluster. This number must be greater // than 2 and not 4, otherwise you receive a validation exception. DedicatedMasterCount *int64 `type:"integer"` // Indicates whether dedicated master nodes are enabled for the cluster.True // if the cluster will use a dedicated master node.False if the cluster will // not. DedicatedMasterEnabled *bool `type:"boolean"` // OpenSearch Service instance type of the dedicated master nodes in the cluster. DedicatedMasterType *string `type:"string" enum:"OpenSearchPartitionInstanceType"` // Number of dedicated master nodes in the cluster. This number must be greater // than 1, otherwise you receive a validation exception. InstanceCount *int64 `type:"integer"` // Instance type of data nodes in the cluster. InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"` // A boolean that indicates whether a multi-AZ domain is turned on with a standby // AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html). MultiAZWithStandbyEnabled *bool `type:"boolean"` // The number of warm nodes in the cluster. WarmCount *int64 `type:"integer"` // Whether to enable warm storage for the cluster. WarmEnabled *bool `type:"boolean"` // The instance type for the cluster's warm nodes. WarmType *string `type:"string" enum:"OpenSearchWarmPartitionInstanceType"` // Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled // is true. ZoneAwarenessConfig *ZoneAwarenessConfig `type:"structure"` // Indicates whether multiple Availability Zones are enabled. For more information, // see Configuring a multi-AZ domain in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html). ZoneAwarenessEnabled *bool `type:"boolean"` // contains filtered or unexported fields }
Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html).
func (s ClusterConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterConfig) SetColdStorageOptions(v *ColdStorageOptions) *ClusterConfig
SetColdStorageOptions sets the ColdStorageOptions field's value.
func (s *ClusterConfig) SetDedicatedMasterCount(v int64) *ClusterConfig
SetDedicatedMasterCount sets the DedicatedMasterCount field's value.
func (s *ClusterConfig) SetDedicatedMasterEnabled(v bool) *ClusterConfig
SetDedicatedMasterEnabled sets the DedicatedMasterEnabled field's value.
func (s *ClusterConfig) SetDedicatedMasterType(v string) *ClusterConfig
SetDedicatedMasterType sets the DedicatedMasterType field's value.
func (s *ClusterConfig) SetInstanceCount(v int64) *ClusterConfig
SetInstanceCount sets the InstanceCount field's value.
func (s *ClusterConfig) SetInstanceType(v string) *ClusterConfig
SetInstanceType sets the InstanceType field's value.
func (s *ClusterConfig) SetMultiAZWithStandbyEnabled(v bool) *ClusterConfig
SetMultiAZWithStandbyEnabled sets the MultiAZWithStandbyEnabled field's value.
func (s *ClusterConfig) SetWarmCount(v int64) *ClusterConfig
SetWarmCount sets the WarmCount field's value.
func (s *ClusterConfig) SetWarmEnabled(v bool) *ClusterConfig
SetWarmEnabled sets the WarmEnabled field's value.
func (s *ClusterConfig) SetWarmType(v string) *ClusterConfig
SetWarmType sets the WarmType field's value.
func (s *ClusterConfig) SetZoneAwarenessConfig(v *ZoneAwarenessConfig) *ClusterConfig
SetZoneAwarenessConfig sets the ZoneAwarenessConfig field's value.
func (s *ClusterConfig) SetZoneAwarenessEnabled(v bool) *ClusterConfig
SetZoneAwarenessEnabled sets the ZoneAwarenessEnabled field's value.
func (s ClusterConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ClusterConfigStatus struct { // Cluster configuration options for the specified domain. // // Options is a required field Options *ClusterConfig `type:"structure" required:"true"` // The status of cluster configuration options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The cluster configuration status for a domain.
func (s ClusterConfigStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClusterConfigStatus) SetOptions(v *ClusterConfig) *ClusterConfigStatus
SetOptions sets the Options field's value.
func (s *ClusterConfigStatus) SetStatus(v *OptionStatus) *ClusterConfigStatus
SetStatus sets the Status field's value.
func (s ClusterConfigStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CognitoOptions struct { // Whether to enable or disable Amazon Cognito authentication for OpenSearch // Dashboards. Enabled *bool `type:"boolean"` // The Amazon Cognito identity pool ID that you want OpenSearch Service to use // for OpenSearch Dashboards authentication. IdentityPoolId *string `min:"1" type:"string"` // The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service // to configure your user pool and identity pool. RoleArn *string `min:"20" type:"string"` // The Amazon Cognito user pool ID that you want OpenSearch Service to use for // OpenSearch Dashboards authentication. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).
func (s CognitoOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CognitoOptions) SetEnabled(v bool) *CognitoOptions
SetEnabled sets the Enabled field's value.
func (s *CognitoOptions) SetIdentityPoolId(v string) *CognitoOptions
SetIdentityPoolId sets the IdentityPoolId field's value.
func (s *CognitoOptions) SetRoleArn(v string) *CognitoOptions
SetRoleArn sets the RoleArn field's value.
func (s *CognitoOptions) SetUserPoolId(v string) *CognitoOptions
SetUserPoolId sets the UserPoolId field's value.
func (s CognitoOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CognitoOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CognitoOptionsStatus struct { // Cognito options for the specified domain. // // Options is a required field Options *CognitoOptions `type:"structure" required:"true"` // The status of the Cognito options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The status of the Cognito options for the specified domain.
func (s CognitoOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CognitoOptionsStatus) SetOptions(v *CognitoOptions) *CognitoOptionsStatus
SetOptions sets the Options field's value.
func (s *CognitoOptionsStatus) SetStatus(v *OptionStatus) *CognitoOptionsStatus
SetStatus sets the Status field's value.
func (s CognitoOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ColdStorageOptions struct { // Whether to enable or disable cold storage on the domain. // // Enabled is a required field Enabled *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html).
func (s ColdStorageOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ColdStorageOptions) SetEnabled(v bool) *ColdStorageOptions
SetEnabled sets the Enabled field's value.
func (s ColdStorageOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ColdStorageOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompatibleVersionsMap struct { // The current version that the OpenSearch Service domain is running. SourceVersion *string `min:"14" type:"string"` // The possible versions that you can upgrade the domain to. TargetVersions []*string `type:"list"` // contains filtered or unexported fields }
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
func (s CompatibleVersionsMap) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CompatibleVersionsMap) SetSourceVersion(v string) *CompatibleVersionsMap
SetSourceVersion sets the SourceVersion field's value.
func (s *CompatibleVersionsMap) SetTargetVersions(v []*string) *CompatibleVersionsMap
SetTargetVersions sets the TargetVersions field's value.
func (s CompatibleVersionsMap) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An error occurred because the client attempts to remove a resource that is currently in use.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConnectionProperties struct { // The endpoint of the remote domain. Endpoint *string `type:"string"` // contains filtered or unexported fields }
The connection properties of an outbound connection.
func (s ConnectionProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConnectionProperties) SetEndpoint(v string) *ConnectionProperties
SetEndpoint sets the Endpoint field's value.
func (s ConnectionProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateDomainInput struct { // Identity and Access Management (IAM) policy document specifying the access // policies for the new domain. AccessPolicies *string `type:"string"` // Key-value pairs to specify advanced configuration options. The following // key-value pairs are supported: // // * "rest.action.multi.allow_explicit_index": "true" | "false" - Note the // use of a string rather than a boolean. Specifies whether explicit references // to indexes are allowed inside the body of HTTP requests. If you want to // configure access policies for domain sub-resources, such as specific indexes // and domain APIs, you must disable this property. Default is true. // // * "indices.fielddata.cache.size": "80" - Note the use of a string rather // than a boolean. Specifies the percentage of heap space allocated to field // data. Default is unbounded. // // * "indices.query.bool.max_clause_count": "1024" - Note the use of a string // rather than a boolean. Specifies the maximum number of clauses allowed // in a Lucene boolean query. Default is 1,024. Queries with more than the // permitted number of clauses result in a TooManyClauses error. // // * "override_main_response_version": "true" | "false" - Note the use of // a string rather than a boolean. Specifies whether the domain reports its // version as 7.10 to allow Elasticsearch OSS clients and plugins to continue // working with it. Default is false when creating a domain and true when // upgrading a domain. // // For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). AdvancedOptions map[string]*string `type:"map"` // Options for fine-grained access control. AdvancedSecurityOptions *AdvancedSecurityOptionsInput_ `type:"structure"` // Options for Auto-Tune. AutoTuneOptions *AutoTuneOptionsInput_ `type:"structure"` // Container for the cluster configuration of a domain. ClusterConfig *ClusterConfig `type:"structure"` // Key-value pairs to configure Amazon Cognito authentication. For more information, // see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html). CognitoOptions *CognitoOptions `type:"structure"` // Additional options for the domain endpoint, such as whether to require HTTPS // for all traffic. DomainEndpointOptions *DomainEndpointOptions `type:"structure"` // Name of the OpenSearch Service domain to create. Domain names are unique // across the domains owned by an account within an Amazon Web Services Region. // // DomainName is a required field DomainName *string `min:"3" type:"string" required:"true"` // Container for the parameters required to enable EBS-based storage for an // OpenSearch Service domain. EBSOptions *EBSOptions `type:"structure"` // Key-value pairs to enable encryption at rest. EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"` // String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine // version for the OpenSearch Service domain. For example, OpenSearch_1.0 or // Elasticsearch_7.9. For more information, see Creating and managing Amazon // OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains). EngineVersion *string `min:"14" type:"string"` // Key-value pairs to configure log publishing. LogPublishingOptions map[string]*LogPublishingOption `type:"map"` // Enables node-to-node encryption. NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"` // Specifies a daily 10-hour time block during which OpenSearch Service can // perform configuration changes on the domain, including service software updates // and Auto-Tune enhancements that require a blue/green deployment. If no options // are specified, the default start time of 10:00 P.M. local time (for the Region // that the domain is created in) is used. OffPeakWindowOptions *OffPeakWindowOptions `type:"structure"` // DEPRECATED. Container for the parameters required to configure automated // snapshots of domain indexes. SnapshotOptions *SnapshotOptions `type:"structure"` // Software update options for the domain. SoftwareUpdateOptions *SoftwareUpdateOptions `type:"structure"` // List of tags to add to the domain upon creation. TagList []*Tag `type:"list"` // Container for the values required to configure VPC access domains. If you // don't specify these values, OpenSearch Service creates the domain with a // public endpoint. For more information, see Launching your Amazon OpenSearch // Service domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). VPCOptions *VPCOptions `type:"structure"` // contains filtered or unexported fields }
func (s CreateDomainInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDomainInput) SetAccessPolicies(v string) *CreateDomainInput
SetAccessPolicies sets the AccessPolicies field's value.
func (s *CreateDomainInput) SetAdvancedOptions(v map[string]*string) *CreateDomainInput
SetAdvancedOptions sets the AdvancedOptions field's value.
func (s *CreateDomainInput) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsInput_) *CreateDomainInput
SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.
func (s *CreateDomainInput) SetAutoTuneOptions(v *AutoTuneOptionsInput_) *CreateDomainInput
SetAutoTuneOptions sets the AutoTuneOptions field's value.
func (s *CreateDomainInput) SetClusterConfig(v *ClusterConfig) *CreateDomainInput
SetClusterConfig sets the ClusterConfig field's value.
func (s *CreateDomainInput) SetCognitoOptions(v *CognitoOptions) *CreateDomainInput
SetCognitoOptions sets the CognitoOptions field's value.
func (s *CreateDomainInput) SetDomainEndpointOptions(v *DomainEndpointOptions) *CreateDomainInput
SetDomainEndpointOptions sets the DomainEndpointOptions field's value.
func (s *CreateDomainInput) SetDomainName(v string) *CreateDomainInput
SetDomainName sets the DomainName field's value.
func (s *CreateDomainInput) SetEBSOptions(v *EBSOptions) *CreateDomainInput
SetEBSOptions sets the EBSOptions field's value.
func (s *CreateDomainInput) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *CreateDomainInput
SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.
func (s *CreateDomainInput) SetEngineVersion(v string) *CreateDomainInput
SetEngineVersion sets the EngineVersion field's value.
func (s *CreateDomainInput) SetLogPublishingOptions(v map[string]*LogPublishingOption) *CreateDomainInput
SetLogPublishingOptions sets the LogPublishingOptions field's value.
func (s *CreateDomainInput) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *CreateDomainInput
SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.
func (s *CreateDomainInput) SetOffPeakWindowOptions(v *OffPeakWindowOptions) *CreateDomainInput
SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.
func (s *CreateDomainInput) SetSnapshotOptions(v *SnapshotOptions) *CreateDomainInput
SetSnapshotOptions sets the SnapshotOptions field's value.
func (s *CreateDomainInput) SetSoftwareUpdateOptions(v *SoftwareUpdateOptions) *CreateDomainInput
SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.
func (s *CreateDomainInput) SetTagList(v []*Tag) *CreateDomainInput
SetTagList sets the TagList field's value.
func (s *CreateDomainInput) SetVPCOptions(v *VPCOptions) *CreateDomainInput
SetVPCOptions sets the VPCOptions field's value.
func (s CreateDomainInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDomainOutput struct { // The status of the newly created domain. DomainStatus *DomainStatus `type:"structure"` // contains filtered or unexported fields }
The result of a CreateDomain operation. Contains the status of the newly created domain.
func (s CreateDomainOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDomainOutput) SetDomainStatus(v *DomainStatus) *CreateDomainOutput
SetDomainStatus sets the DomainStatus field's value.
func (s CreateDomainOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateOutboundConnectionInput struct { // Name of the connection. // // ConnectionAlias is a required field ConnectionAlias *string `min:"2" type:"string" required:"true"` // The connection mode. ConnectionMode *string `type:"string" enum:"ConnectionMode"` // Name and Region of the source (local) domain. // // LocalDomainInfo is a required field LocalDomainInfo *DomainInformationContainer `type:"structure" required:"true"` // Name and Region of the destination (remote) domain. // // RemoteDomainInfo is a required field RemoteDomainInfo *DomainInformationContainer `type:"structure" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the CreateOutboundConnection operation.
func (s CreateOutboundConnectionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateOutboundConnectionInput) SetConnectionAlias(v string) *CreateOutboundConnectionInput
SetConnectionAlias sets the ConnectionAlias field's value.
func (s *CreateOutboundConnectionInput) SetConnectionMode(v string) *CreateOutboundConnectionInput
SetConnectionMode sets the ConnectionMode field's value.
func (s *CreateOutboundConnectionInput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput
SetLocalDomainInfo sets the LocalDomainInfo field's value.
func (s *CreateOutboundConnectionInput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionInput
SetRemoteDomainInfo sets the RemoteDomainInfo field's value.
func (s CreateOutboundConnectionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateOutboundConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateOutboundConnectionOutput struct { // Name of the connection. ConnectionAlias *string `min:"2" type:"string"` // The unique identifier for the created outbound connection, which is used // for subsequent operations on the connection. ConnectionId *string `min:"10" type:"string"` // The connection mode. ConnectionMode *string `type:"string" enum:"ConnectionMode"` // The ConnectionProperties for the newly created connection. ConnectionProperties *ConnectionProperties `type:"structure"` // The status of the connection. ConnectionStatus *OutboundConnectionStatus `type:"structure"` // Information about the source (local) domain. LocalDomainInfo *DomainInformationContainer `type:"structure"` // Information about the destination (remote) domain. RemoteDomainInfo *DomainInformationContainer `type:"structure"` // contains filtered or unexported fields }
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
func (s CreateOutboundConnectionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateOutboundConnectionOutput) SetConnectionAlias(v string) *CreateOutboundConnectionOutput
SetConnectionAlias sets the ConnectionAlias field's value.
func (s *CreateOutboundConnectionOutput) SetConnectionId(v string) *CreateOutboundConnectionOutput
SetConnectionId sets the ConnectionId field's value.
func (s *CreateOutboundConnectionOutput) SetConnectionMode(v string) *CreateOutboundConnectionOutput
SetConnectionMode sets the ConnectionMode field's value.
func (s *CreateOutboundConnectionOutput) SetConnectionProperties(v *ConnectionProperties) *CreateOutboundConnectionOutput
SetConnectionProperties sets the ConnectionProperties field's value.
func (s *CreateOutboundConnectionOutput) SetConnectionStatus(v *OutboundConnectionStatus) *CreateOutboundConnectionOutput
SetConnectionStatus sets the ConnectionStatus field's value.
func (s *CreateOutboundConnectionOutput) SetLocalDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput
SetLocalDomainInfo sets the LocalDomainInfo field's value.
func (s *CreateOutboundConnectionOutput) SetRemoteDomainInfo(v *DomainInformationContainer) *CreateOutboundConnectionOutput
SetRemoteDomainInfo sets the RemoteDomainInfo field's value.
func (s CreateOutboundConnectionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreatePackageInput struct { // Description of the package. PackageDescription *string `type:"string"` // Unique name for the package. // // PackageName is a required field PackageName *string `min:"3" type:"string" required:"true"` // The Amazon S3 location from which to import the package. // // PackageSource is a required field PackageSource *PackageSource `type:"structure" required:"true"` // The type of package. // // PackageType is a required field PackageType *string `type:"string" required:"true" enum:"PackageType"` // contains filtered or unexported fields }
Container for request parameters to the CreatePackage operation.
func (s CreatePackageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePackageInput) SetPackageDescription(v string) *CreatePackageInput
SetPackageDescription sets the PackageDescription field's value.
func (s *CreatePackageInput) SetPackageName(v string) *CreatePackageInput
SetPackageName sets the PackageName field's value.
func (s *CreatePackageInput) SetPackageSource(v *PackageSource) *CreatePackageInput
SetPackageSource sets the PackageSource field's value.
func (s *CreatePackageInput) SetPackageType(v string) *CreatePackageInput
SetPackageType sets the PackageType field's value.
func (s CreatePackageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePackageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePackageOutput struct { // Basic information about an OpenSearch Service package. PackageDetails *PackageDetails `type:"structure"` // contains filtered or unexported fields }
Container for the response returned by the CreatePackage operation.
func (s CreatePackageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePackageOutput) SetPackageDetails(v *PackageDetails) *CreatePackageOutput
SetPackageDetails sets the PackageDetails field's value.
func (s CreatePackageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateVpcEndpointInput struct { // Unique, case-sensitive identifier to ensure idempotency of the request. ClientToken *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the domain to create the endpoint for. // // DomainArn is a required field DomainArn *string `min:"1" type:"string" required:"true"` // Options to specify the subnets and security groups for the endpoint. // // VpcOptions is a required field VpcOptions *VPCOptions `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateVpcEndpointInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateVpcEndpointInput) SetClientToken(v string) *CreateVpcEndpointInput
SetClientToken sets the ClientToken field's value.
func (s *CreateVpcEndpointInput) SetDomainArn(v string) *CreateVpcEndpointInput
SetDomainArn sets the DomainArn field's value.
func (s *CreateVpcEndpointInput) SetVpcOptions(v *VPCOptions) *CreateVpcEndpointInput
SetVpcOptions sets the VpcOptions field's value.
func (s CreateVpcEndpointInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateVpcEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateVpcEndpointOutput struct { // Information about the newly created VPC endpoint. // // VpcEndpoint is a required field VpcEndpoint *VpcEndpoint `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateVpcEndpointOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateVpcEndpointOutput) SetVpcEndpoint(v *VpcEndpoint) *CreateVpcEndpointOutput
SetVpcEndpoint sets the VpcEndpoint field's value.
func (s CreateVpcEndpointOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteDomainInput struct { // The name of the domain you want to permanently delete. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DeleteDomain operation.
func (s DeleteDomainInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDomainInput) SetDomainName(v string) *DeleteDomainInput
SetDomainName sets the DomainName field's value.
func (s DeleteDomainInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDomainOutput struct { // The status of the domain being deleted. DomainStatus *DomainStatus `type:"structure"` // contains filtered or unexported fields }
The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.
func (s DeleteDomainOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDomainOutput) SetDomainStatus(v *DomainStatus) *DeleteDomainOutput
SetDomainStatus sets the DomainStatus field's value.
func (s DeleteDomainOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteInboundConnectionInput struct { // The ID of the inbound connection to permanently delete. // // ConnectionId is a required field ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DeleteInboundConnection operation.
func (s DeleteInboundConnectionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteInboundConnectionInput) SetConnectionId(v string) *DeleteInboundConnectionInput
SetConnectionId sets the ConnectionId field's value.
func (s DeleteInboundConnectionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteInboundConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteInboundConnectionOutput struct { // The deleted inbound connection. Connection *InboundConnection `type:"structure"` // contains filtered or unexported fields }
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
func (s DeleteInboundConnectionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteInboundConnectionOutput) SetConnection(v *InboundConnection) *DeleteInboundConnectionOutput
SetConnection sets the Connection field's value.
func (s DeleteInboundConnectionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteOutboundConnectionInput struct { // The ID of the outbound connection you want to permanently delete. // // ConnectionId is a required field ConnectionId *string `location:"uri" locationName:"ConnectionId" min:"10" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DeleteOutboundConnection operation.
func (s DeleteOutboundConnectionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteOutboundConnectionInput) SetConnectionId(v string) *DeleteOutboundConnectionInput
SetConnectionId sets the ConnectionId field's value.
func (s DeleteOutboundConnectionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteOutboundConnectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteOutboundConnectionOutput struct { // The deleted inbound connection. Connection *OutboundConnection `type:"structure"` // contains filtered or unexported fields }
Details about the deleted outbound connection.
func (s DeleteOutboundConnectionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteOutboundConnectionOutput) SetConnection(v *OutboundConnection) *DeleteOutboundConnectionOutput
SetConnection sets the Connection field's value.
func (s DeleteOutboundConnectionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeletePackageInput struct { // The internal ID of the package you want to delete. Use DescribePackages to // find this value. // // PackageID is a required field PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"` // contains filtered or unexported fields }
Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
func (s DeletePackageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePackageInput) SetPackageID(v string) *DeletePackageInput
SetPackageID sets the PackageID field's value.
func (s DeletePackageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePackageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePackageOutput struct { // Information about the deleted package. PackageDetails *PackageDetails `type:"structure"` // contains filtered or unexported fields }
Container for the response parameters to the DeletePackage operation.
func (s DeletePackageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePackageOutput) SetPackageDetails(v *PackageDetails) *DeletePackageOutput
SetPackageDetails sets the PackageDetails field's value.
func (s DeletePackageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteVpcEndpointInput struct { // The unique identifier of the endpoint. // // VpcEndpointId is a required field VpcEndpointId *string `location:"uri" locationName:"VpcEndpointId" min:"5" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteVpcEndpointInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteVpcEndpointInput) SetVpcEndpointId(v string) *DeleteVpcEndpointInput
SetVpcEndpointId sets the VpcEndpointId field's value.
func (s DeleteVpcEndpointInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteVpcEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteVpcEndpointOutput struct { // Information about the deleted endpoint, including its current status (DELETING // or DELETE_FAILED). // // VpcEndpointSummary is a required field VpcEndpointSummary *VpcEndpointSummary `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DeleteVpcEndpointOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteVpcEndpointOutput) SetVpcEndpointSummary(v *VpcEndpointSummary) *DeleteVpcEndpointOutput
SetVpcEndpointSummary sets the VpcEndpointSummary field's value.
func (s DeleteVpcEndpointOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DependencyFailureException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
func (s *DependencyFailureException) Code() string
Code returns the exception type name.
func (s *DependencyFailureException) Error() string
func (s DependencyFailureException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DependencyFailureException) Message() string
Message returns the exception's message.
func (s *DependencyFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DependencyFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DependencyFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s DependencyFailureException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainAutoTunesInput struct { // Name of the domain that you want Auto-Tune details about. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `type:"integer"` // If your initial DescribeDomainAutoTunes operation returns a nextToken, you // can include the returned nextToken in subsequent DescribeDomainAutoTunes // operations, which returns results in the next page. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomainAutoTunes operation.
func (s DescribeDomainAutoTunesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainAutoTunesInput) SetDomainName(v string) *DescribeDomainAutoTunesInput
SetDomainName sets the DomainName field's value.
func (s *DescribeDomainAutoTunesInput) SetMaxResults(v int64) *DescribeDomainAutoTunesInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeDomainAutoTunesInput) SetNextToken(v string) *DescribeDomainAutoTunesInput
SetNextToken sets the NextToken field's value.
func (s DescribeDomainAutoTunesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainAutoTunesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainAutoTunesOutput struct { // The list of setting adjustments that Auto-Tune has made to the domain. AutoTunes []*AutoTune `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
The result of a DescribeDomainAutoTunes request.
func (s DescribeDomainAutoTunesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainAutoTunesOutput) SetAutoTunes(v []*AutoTune) *DescribeDomainAutoTunesOutput
SetAutoTunes sets the AutoTunes field's value.
func (s *DescribeDomainAutoTunesOutput) SetNextToken(v string) *DescribeDomainAutoTunesOutput
SetNextToken sets the NextToken field's value.
func (s DescribeDomainAutoTunesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainChangeProgressInput struct { // The specific change ID for which you want to get progress information. If // omitted, the request returns information about the most recent configuration // change. ChangeId *string `location:"querystring" locationName:"changeid" min:"36" type:"string"` // The name of the domain to get progress information for. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomainChangeProgress operation.
func (s DescribeDomainChangeProgressInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainChangeProgressInput) SetChangeId(v string) *DescribeDomainChangeProgressInput
SetChangeId sets the ChangeId field's value.
func (s *DescribeDomainChangeProgressInput) SetDomainName(v string) *DescribeDomainChangeProgressInput
SetDomainName sets the DomainName field's value.
func (s DescribeDomainChangeProgressInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainChangeProgressInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainChangeProgressOutput struct { // Container for information about the stages of a configuration change happening // on a domain. ChangeProgressStatus *ChangeProgressStatusDetails `type:"structure"` // contains filtered or unexported fields }
The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.
func (s DescribeDomainChangeProgressOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainChangeProgressOutput) SetChangeProgressStatus(v *ChangeProgressStatusDetails) *DescribeDomainChangeProgressOutput
SetChangeProgressStatus sets the ChangeProgressStatus field's value.
func (s DescribeDomainChangeProgressOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainConfigInput struct { // Name of the OpenSearch Service domain configuration that you want to describe. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomainConfig operation.
func (s DescribeDomainConfigInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainConfigInput) SetDomainName(v string) *DescribeDomainConfigInput
SetDomainName sets the DomainName field's value.
func (s DescribeDomainConfigInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainConfigInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainConfigOutput struct { // Container for the configuration of the OpenSearch Service domain. // // DomainConfig is a required field DomainConfig *DomainConfig `type:"structure" required:"true"` // contains filtered or unexported fields }
Contains the configuration information of the requested domain.
func (s DescribeDomainConfigOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainConfigOutput) SetDomainConfig(v *DomainConfig) *DescribeDomainConfigOutput
SetDomainConfig sets the DomainConfig field's value.
func (s DescribeDomainConfigOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainHealthInput struct { // The name of the domain. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomainHealth operation.
func (s DescribeDomainHealthInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainHealthInput) SetDomainName(v string) *DescribeDomainHealthInput
SetDomainName sets the DomainName field's value.
func (s DescribeDomainHealthInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainHealthInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainHealthOutput struct { // The number of active Availability Zones configured for the domain. If the // service is unable to fetch this information, it will return NotAvailable. ActiveAvailabilityZoneCount *string `type:"string"` // The number of Availability Zones configured for the domain. If the service // is unable to fetch this information, it will return NotAvailable. AvailabilityZoneCount *string `type:"string"` // The current health status of your cluster. // // * Red - At least one primary shard is not allocated to any node. // // * Yellow - All primary shards are allocated to nodes, but some replicas // aren’t. // // * Green - All primary shards and their replicas are allocated to nodes. // // * NotAvailable - Unable to retrieve cluster health. ClusterHealth *string `type:"string" enum:"DomainHealth"` // The number of data nodes configured for the domain. If the service is unable // to fetch this information, it will return NotAvailable. DataNodeCount *string `type:"string"` // A boolean that indicates if dedicated master nodes are activated for the // domain. DedicatedMaster *bool `type:"boolean"` // The current state of the domain. // // * Processing - The domain has updates in progress. // // * Active - Requested changes have been processed and deployed to the domain. DomainState *string `type:"string" enum:"DomainState"` // A list of EnvironmentInfo for the domain. EnvironmentInformation []*EnvironmentInfo `type:"list"` // The number of nodes that can be elected as a master node. If dedicated master // nodes is turned on, this value is the number of dedicated master nodes configured // for the domain. If the service is unable to fetch this information, it will // return NotAvailable. MasterEligibleNodeCount *string `type:"string"` // Indicates whether the domain has an elected master node. // // * Available - The domain has an elected master node. // // * UnAvailable - The master node hasn't yet been elected, and a quorum // to elect a new master node hasn't been reached. MasterNode *string `type:"string" enum:"MasterNodeStatus"` // The number of standby Availability Zones configured for the domain. If the // service is unable to fetch this information, it will return NotAvailable. StandByAvailabilityZoneCount *string `type:"string"` // The total number of primary and replica shards for the domain. TotalShards *string `type:"string"` // The total number of primary and replica shards not allocated to any of the // nodes for the cluster. TotalUnAssignedShards *string `type:"string"` // The number of warm nodes configured for the domain. WarmNodeCount *string `type:"string"` // contains filtered or unexported fields }
The result of a DescribeDomainHealth request. Contains health information for the requested domain.
func (s DescribeDomainHealthOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainHealthOutput) SetActiveAvailabilityZoneCount(v string) *DescribeDomainHealthOutput
SetActiveAvailabilityZoneCount sets the ActiveAvailabilityZoneCount field's value.
func (s *DescribeDomainHealthOutput) SetAvailabilityZoneCount(v string) *DescribeDomainHealthOutput
SetAvailabilityZoneCount sets the AvailabilityZoneCount field's value.
func (s *DescribeDomainHealthOutput) SetClusterHealth(v string) *DescribeDomainHealthOutput
SetClusterHealth sets the ClusterHealth field's value.
func (s *DescribeDomainHealthOutput) SetDataNodeCount(v string) *DescribeDomainHealthOutput
SetDataNodeCount sets the DataNodeCount field's value.
func (s *DescribeDomainHealthOutput) SetDedicatedMaster(v bool) *DescribeDomainHealthOutput
SetDedicatedMaster sets the DedicatedMaster field's value.
func (s *DescribeDomainHealthOutput) SetDomainState(v string) *DescribeDomainHealthOutput
SetDomainState sets the DomainState field's value.
func (s *DescribeDomainHealthOutput) SetEnvironmentInformation(v []*EnvironmentInfo) *DescribeDomainHealthOutput
SetEnvironmentInformation sets the EnvironmentInformation field's value.
func (s *DescribeDomainHealthOutput) SetMasterEligibleNodeCount(v string) *DescribeDomainHealthOutput
SetMasterEligibleNodeCount sets the MasterEligibleNodeCount field's value.
func (s *DescribeDomainHealthOutput) SetMasterNode(v string) *DescribeDomainHealthOutput
SetMasterNode sets the MasterNode field's value.
func (s *DescribeDomainHealthOutput) SetStandByAvailabilityZoneCount(v string) *DescribeDomainHealthOutput
SetStandByAvailabilityZoneCount sets the StandByAvailabilityZoneCount field's value.
func (s *DescribeDomainHealthOutput) SetTotalShards(v string) *DescribeDomainHealthOutput
SetTotalShards sets the TotalShards field's value.
func (s *DescribeDomainHealthOutput) SetTotalUnAssignedShards(v string) *DescribeDomainHealthOutput
SetTotalUnAssignedShards sets the TotalUnAssignedShards field's value.
func (s *DescribeDomainHealthOutput) SetWarmNodeCount(v string) *DescribeDomainHealthOutput
SetWarmNodeCount sets the WarmNodeCount field's value.
func (s DescribeDomainHealthOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainInput struct { // The name of the domain that you want information about. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomain operation.
func (s DescribeDomainInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainInput) SetDomainName(v string) *DescribeDomainInput
SetDomainName sets the DomainName field's value.
func (s DescribeDomainInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainNodesInput struct { // The name of the domain. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomainNodes operation.
func (s DescribeDomainNodesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainNodesInput) SetDomainName(v string) *DescribeDomainNodesInput
SetDomainName sets the DomainName field's value.
func (s DescribeDomainNodesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainNodesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainNodesOutput struct { // Contains nodes information list DomainNodesStatusList with details about // the all nodes on the requested domain. DomainNodesStatusList []*DomainNodesStatus `type:"list"` // contains filtered or unexported fields }
The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.
func (s DescribeDomainNodesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainNodesOutput) SetDomainNodesStatusList(v []*DomainNodesStatus) *DescribeDomainNodesOutput
SetDomainNodesStatusList sets the DomainNodesStatusList field's value.
func (s DescribeDomainNodesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainOutput struct { // List that contains the status of each specified OpenSearch Service domain. // // DomainStatus is a required field DomainStatus *DomainStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
Contains the status of the domain specified in the request.
func (s DescribeDomainOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainOutput) SetDomainStatus(v *DomainStatus) *DescribeDomainOutput
SetDomainStatus sets the DomainStatus field's value.
func (s DescribeDomainOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDomainsInput struct { // Array of OpenSearch Service domain names that you want information about. // If you don't specify any domains, OpenSearch Service returns information // about all domains owned by the account. // // DomainNames is a required field DomainNames []*string `type:"list" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the DescribeDomains operation.
func (s DescribeDomainsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainsInput) SetDomainNames(v []*string) *DescribeDomainsInput
SetDomainNames sets the DomainNames field's value.
func (s DescribeDomainsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDomainsOutput struct { // The status of the requested domains. // // DomainStatusList is a required field DomainStatusList []*DomainStatus `type:"list" required:"true"` // contains filtered or unexported fields }
Contains the status of the specified domains or all domains owned by the account.
func (s DescribeDomainsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDomainsOutput) SetDomainStatusList(v []*DomainStatus) *DescribeDomainsOutput
SetDomainStatusList sets the DomainStatusList field's value.
func (s DescribeDomainsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDryRunProgressInput struct { // The name of the domain. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // The unique identifier of the dry run. DryRunId *string `location:"querystring" locationName:"dryRunId" min:"36" type:"string"` // Whether to include the configuration of the dry run in the response. The // configuration specifies the updates that you're planning to make on the domain. LoadDryRunConfig *bool `location:"querystring" locationName:"loadDryRunConfig" type:"boolean"` // contains filtered or unexported fields }
func (s DescribeDryRunProgressInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDryRunProgressInput) SetDomainName(v string) *DescribeDryRunProgressInput
SetDomainName sets the DomainName field's value.
func (s *DescribeDryRunProgressInput) SetDryRunId(v string) *DescribeDryRunProgressInput
SetDryRunId sets the DryRunId field's value.
func (s *DescribeDryRunProgressInput) SetLoadDryRunConfig(v bool) *DescribeDryRunProgressInput
SetLoadDryRunConfig sets the LoadDryRunConfig field's value.
func (s DescribeDryRunProgressInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDryRunProgressInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDryRunProgressOutput struct { // Details about the changes you're planning to make on the domain. DryRunConfig *DomainStatus `type:"structure"` // The current status of the dry run, including any validation errors. DryRunProgressStatus *DryRunProgressStatus `type:"structure"` // The results of the dry run. DryRunResults *DryRunResults `type:"structure"` // contains filtered or unexported fields }
func (s DescribeDryRunProgressOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDryRunProgressOutput) SetDryRunConfig(v *DomainStatus) *DescribeDryRunProgressOutput
SetDryRunConfig sets the DryRunConfig field's value.
func (s *DescribeDryRunProgressOutput) SetDryRunProgressStatus(v *DryRunProgressStatus) *DescribeDryRunProgressOutput
SetDryRunProgressStatus sets the DryRunProgressStatus field's value.
func (s *DescribeDryRunProgressOutput) SetDryRunResults(v *DryRunResults) *DescribeDryRunProgressOutput
SetDryRunResults sets the DryRunResults field's value.
func (s DescribeDryRunProgressOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeInboundConnectionsInput struct { // A list of filters used to match properties for inbound cross-cluster connections. Filters []*Filter `type:"list"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `type:"integer"` // If your initial DescribeInboundConnections operation returns a nextToken, // you can include the returned nextToken in subsequent DescribeInboundConnections // operations, which returns results in the next page. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the parameters to the DescribeInboundConnections operation.
func (s DescribeInboundConnectionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInboundConnectionsInput) SetFilters(v []*Filter) *DescribeInboundConnectionsInput
SetFilters sets the Filters field's value.
func (s *DescribeInboundConnectionsInput) SetMaxResults(v int64) *DescribeInboundConnectionsInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeInboundConnectionsInput) SetNextToken(v string) *DescribeInboundConnectionsInput
SetNextToken sets the NextToken field's value.
func (s DescribeInboundConnectionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInboundConnectionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeInboundConnectionsOutput struct { // List of inbound connections. Connections []*InboundConnection `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains a list of connections matching the filter criteria.
func (s DescribeInboundConnectionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInboundConnectionsOutput) SetConnections(v []*InboundConnection) *DescribeInboundConnectionsOutput
SetConnections sets the Connections field's value.
func (s *DescribeInboundConnectionsOutput) SetNextToken(v string) *DescribeInboundConnectionsOutput
SetNextToken sets the NextToken field's value.
func (s DescribeInboundConnectionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeInstanceTypeLimitsInput struct { // The name of the domain. Only specify if you need the limits for an existing // domain. DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"` // Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or // OpenSearch_X.Y. Defaults to the latest version of OpenSearch. // // EngineVersion is a required field EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"` // The OpenSearch Service instance type for which you need limit information. // // InstanceType is a required field InstanceType *string `location:"uri" locationName:"InstanceType" type:"string" required:"true" enum:"OpenSearchPartitionInstanceType"` // contains filtered or unexported fields }
Container for the parameters to the DescribeInstanceTypeLimits operation.
func (s DescribeInstanceTypeLimitsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInstanceTypeLimitsInput) SetDomainName(v string) *DescribeInstanceTypeLimitsInput
SetDomainName sets the DomainName field's value.
func (s *DescribeInstanceTypeLimitsInput) SetEngineVersion(v string) *DescribeInstanceTypeLimitsInput
SetEngineVersion sets the EngineVersion field's value.
func (s *DescribeInstanceTypeLimitsInput) SetInstanceType(v string) *DescribeInstanceTypeLimitsInput
SetInstanceType sets the InstanceType field's value.
func (s DescribeInstanceTypeLimitsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInstanceTypeLimitsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeInstanceTypeLimitsOutput struct { // Map that contains all applicable instance type limits.data refers to data // nodes.master refers to dedicated master nodes. LimitsByRole map[string]*Limits `type:"map"` // contains filtered or unexported fields }
Container for the parameters received from the DescribeInstanceTypeLimits operation.
func (s DescribeInstanceTypeLimitsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeInstanceTypeLimitsOutput) SetLimitsByRole(v map[string]*Limits) *DescribeInstanceTypeLimitsOutput
SetLimitsByRole sets the LimitsByRole field's value.
func (s DescribeInstanceTypeLimitsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeOutboundConnectionsInput struct { // List of filter names and values that you can use for requests. Filters []*Filter `type:"list"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `type:"integer"` // If your initial DescribeOutboundConnections operation returns a nextToken, // you can include the returned nextToken in subsequent DescribeOutboundConnections // operations, which returns results in the next page. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the parameters to the DescribeOutboundConnections operation.
func (s DescribeOutboundConnectionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeOutboundConnectionsInput) SetFilters(v []*Filter) *DescribeOutboundConnectionsInput
SetFilters sets the Filters field's value.
func (s *DescribeOutboundConnectionsInput) SetMaxResults(v int64) *DescribeOutboundConnectionsInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeOutboundConnectionsInput) SetNextToken(v string) *DescribeOutboundConnectionsInput
SetNextToken sets the NextToken field's value.
func (s DescribeOutboundConnectionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeOutboundConnectionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeOutboundConnectionsOutput struct { // List of outbound connections that match the filter criteria. Connections []*OutboundConnection `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains a list of connections matching the filter criteria.
func (s DescribeOutboundConnectionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeOutboundConnectionsOutput) SetConnections(v []*OutboundConnection) *DescribeOutboundConnectionsOutput
SetConnections sets the Connections field's value.
func (s *DescribeOutboundConnectionsOutput) SetNextToken(v string) *DescribeOutboundConnectionsOutput
SetNextToken sets the NextToken field's value.
func (s DescribeOutboundConnectionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribePackagesFilter struct { // Any field from PackageDetails. Name *string `type:"string" enum:"DescribePackagesFilterName"` // A non-empty list of values for the specified filter field. Value []*string `min:"1" type:"list"` // contains filtered or unexported fields }
A filter to apply to the DescribePackage response.
func (s DescribePackagesFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePackagesFilter) SetName(v string) *DescribePackagesFilter
SetName sets the Name field's value.
func (s *DescribePackagesFilter) SetValue(v []*string) *DescribePackagesFilter
SetValue sets the Value field's value.
func (s DescribePackagesFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePackagesFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribePackagesInput struct { // Only returns packages that match the DescribePackagesFilterList values. Filters []*DescribePackagesFilter `type:"list"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `type:"integer"` // If your initial DescribePackageFilters operation returns a nextToken, you // can include the returned nextToken in subsequent DescribePackageFilters operations, // which returns results in the next page. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the request parameters to the DescribePackage operation.
func (s DescribePackagesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePackagesInput) SetFilters(v []*DescribePackagesFilter) *DescribePackagesInput
SetFilters sets the Filters field's value.
func (s *DescribePackagesInput) SetMaxResults(v int64) *DescribePackagesInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribePackagesInput) SetNextToken(v string) *DescribePackagesInput
SetNextToken sets the NextToken field's value.
func (s DescribePackagesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePackagesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribePackagesOutput struct { // When 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. NextToken *string `type:"string"` // Basic information about a package. PackageDetailsList []*PackageDetails `type:"list"` // contains filtered or unexported fields }
Container for the response returned by the DescribePackages operation.
func (s DescribePackagesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePackagesOutput) SetNextToken(v string) *DescribePackagesOutput
SetNextToken sets the NextToken field's value.
func (s *DescribePackagesOutput) SetPackageDetailsList(v []*PackageDetails) *DescribePackagesOutput
SetPackageDetailsList sets the PackageDetailsList field's value.
func (s DescribePackagesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeReservedInstanceOfferingsInput struct { // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial DescribeReservedInstanceOfferings operation returns a nextToken, // you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings // operations, which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // The Reserved Instance identifier filter value. Use this parameter to show // only the available instance types that match the specified reservation identifier. ReservedInstanceOfferingId *string `location:"querystring" locationName:"offeringId" min:"36" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to a DescribeReservedInstanceOfferings operation.
func (s DescribeReservedInstanceOfferingsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstanceOfferingsInput) SetMaxResults(v int64) *DescribeReservedInstanceOfferingsInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeReservedInstanceOfferingsInput) SetNextToken(v string) *DescribeReservedInstanceOfferingsInput
SetNextToken sets the NextToken field's value.
func (s *DescribeReservedInstanceOfferingsInput) SetReservedInstanceOfferingId(v string) *DescribeReservedInstanceOfferingsInput
SetReservedInstanceOfferingId sets the ReservedInstanceOfferingId field's value.
func (s DescribeReservedInstanceOfferingsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstanceOfferingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeReservedInstanceOfferingsOutput struct { // When 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. NextToken *string `type:"string"` // List of Reserved Instance offerings. ReservedInstanceOfferings []*ReservedInstanceOffering `type:"list"` // contains filtered or unexported fields }
Container for results of a DescribeReservedInstanceOfferings request.
func (s DescribeReservedInstanceOfferingsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstanceOfferingsOutput) SetNextToken(v string) *DescribeReservedInstanceOfferingsOutput
SetNextToken sets the NextToken field's value.
func (s *DescribeReservedInstanceOfferingsOutput) SetReservedInstanceOfferings(v []*ReservedInstanceOffering) *DescribeReservedInstanceOfferingsOutput
SetReservedInstanceOfferings sets the ReservedInstanceOfferings field's value.
func (s DescribeReservedInstanceOfferingsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeReservedInstancesInput struct { // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial DescribeReservedInstances operation returns a nextToken, // you can include the returned nextToken in subsequent DescribeReservedInstances // operations, which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // The reserved instance identifier filter value. Use this parameter to show // only the reservation that matches the specified reserved OpenSearch instance // ID. ReservedInstanceId *string `location:"querystring" locationName:"reservationId" min:"36" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to the DescribeReservedInstances operation.
func (s DescribeReservedInstancesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstancesInput) SetMaxResults(v int64) *DescribeReservedInstancesInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeReservedInstancesInput) SetNextToken(v string) *DescribeReservedInstancesInput
SetNextToken sets the NextToken field's value.
func (s *DescribeReservedInstancesInput) SetReservedInstanceId(v string) *DescribeReservedInstancesInput
SetReservedInstanceId sets the ReservedInstanceId field's value.
func (s DescribeReservedInstancesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeReservedInstancesOutput struct { // When 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. NextToken *string `type:"string"` // List of Reserved Instances in the current Region. ReservedInstances []*ReservedInstance `type:"list"` // contains filtered or unexported fields }
Container for results from DescribeReservedInstances
func (s DescribeReservedInstancesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeReservedInstancesOutput) SetNextToken(v string) *DescribeReservedInstancesOutput
SetNextToken sets the NextToken field's value.
func (s *DescribeReservedInstancesOutput) SetReservedInstances(v []*ReservedInstance) *DescribeReservedInstancesOutput
SetReservedInstances sets the ReservedInstances field's value.
func (s DescribeReservedInstancesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeVpcEndpointsInput struct { // The unique identifiers of the endpoints to get information about. // // VpcEndpointIds is a required field VpcEndpointIds []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (s DescribeVpcEndpointsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeVpcEndpointsInput) SetVpcEndpointIds(v []*string) *DescribeVpcEndpointsInput
SetVpcEndpointIds sets the VpcEndpointIds field's value.
func (s DescribeVpcEndpointsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeVpcEndpointsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeVpcEndpointsOutput struct { // Any errors associated with the request. // // VpcEndpointErrors is a required field VpcEndpointErrors []*VpcEndpointError `type:"list" required:"true"` // Information about each requested VPC endpoint. // // VpcEndpoints is a required field VpcEndpoints []*VpcEndpoint `type:"list" required:"true"` // contains filtered or unexported fields }
func (s DescribeVpcEndpointsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeVpcEndpointsOutput) SetVpcEndpointErrors(v []*VpcEndpointError) *DescribeVpcEndpointsOutput
SetVpcEndpointErrors sets the VpcEndpointErrors field's value.
func (s *DescribeVpcEndpointsOutput) SetVpcEndpoints(v []*VpcEndpoint) *DescribeVpcEndpointsOutput
SetVpcEndpoints sets the VpcEndpoints field's value.
func (s DescribeVpcEndpointsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisabledOperationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An error occured because the client wanted to access an unsupported operation.
func (s *DisabledOperationException) Code() string
Code returns the exception type name.
func (s *DisabledOperationException) Error() string
func (s DisabledOperationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisabledOperationException) Message() string
Message returns the exception's message.
func (s *DisabledOperationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DisabledOperationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DisabledOperationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s DisabledOperationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DissociatePackageInput struct { // Name of the domain to dissociate the package from. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain // to find this value. // // PackageID is a required field PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to the DissociatePackage operation.
func (s DissociatePackageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DissociatePackageInput) SetDomainName(v string) *DissociatePackageInput
SetDomainName sets the DomainName field's value.
func (s *DissociatePackageInput) SetPackageID(v string) *DissociatePackageInput
SetPackageID sets the PackageID field's value.
func (s DissociatePackageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DissociatePackageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DissociatePackageOutput struct { // Information about a package that has been dissociated from the domain. DomainPackageDetails *DomainPackageDetails `type:"structure"` // contains filtered or unexported fields }
Container for the response returned by an DissociatePackage operation.
func (s DissociatePackageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DissociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetails) *DissociatePackageOutput
SetDomainPackageDetails sets the DomainPackageDetails field's value.
func (s DissociatePackageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainConfig struct { // Specifies the access policies for the domain. AccessPolicies *AccessPoliciesStatus `type:"structure"` // Key-value pairs to specify advanced configuration options. For more information, // see Advanced options (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). AdvancedOptions *AdvancedOptionsStatus `type:"structure"` // Container for fine-grained access control settings for the domain. AdvancedSecurityOptions *AdvancedSecurityOptionsStatus `type:"structure"` // Container for Auto-Tune settings for the domain. AutoTuneOptions *AutoTuneOptionsStatus `type:"structure"` // Container for information about the progress of an existing configuration // change. ChangeProgressDetails *ChangeProgressDetails `type:"structure"` // Container for the cluster configuration of a the domain. ClusterConfig *ClusterConfigStatus `type:"structure"` // Container for Amazon Cognito options for the domain. CognitoOptions *CognitoOptionsStatus `type:"structure"` // Additional options for the domain endpoint, such as whether to require HTTPS // for all traffic. DomainEndpointOptions *DomainEndpointOptionsStatus `type:"structure"` // Container for EBS options configured for the domain. EBSOptions *EBSOptionsStatus `type:"structure"` // Key-value pairs to enable encryption at rest. EncryptionAtRestOptions *EncryptionAtRestOptionsStatus `type:"structure"` // The OpenSearch or Elasticsearch version that the domain is running. EngineVersion *VersionStatus `type:"structure"` // Key-value pairs to configure log publishing. LogPublishingOptions *LogPublishingOptionsStatus `type:"structure"` // Whether node-to-node encryption is enabled or disabled. NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptionsStatus `type:"structure"` // Container for off-peak window options for the domain. OffPeakWindowOptions *OffPeakWindowOptionsStatus `type:"structure"` // DEPRECATED. Container for parameters required to configure automated snapshots // of domain indexes. SnapshotOptions *SnapshotOptionsStatus `type:"structure"` // Software update options for the domain. SoftwareUpdateOptions *SoftwareUpdateOptionsStatus `type:"structure"` // The current VPC options for the domain and the status of any updates to their // configuration. VPCOptions *VPCDerivedInfoStatus `type:"structure"` // contains filtered or unexported fields }
Container for the configuration of an OpenSearch Service domain.
func (s DomainConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainConfig) SetAccessPolicies(v *AccessPoliciesStatus) *DomainConfig
SetAccessPolicies sets the AccessPolicies field's value.
func (s *DomainConfig) SetAdvancedOptions(v *AdvancedOptionsStatus) *DomainConfig
SetAdvancedOptions sets the AdvancedOptions field's value.
func (s *DomainConfig) SetAdvancedSecurityOptions(v *AdvancedSecurityOptionsStatus) *DomainConfig
SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.
func (s *DomainConfig) SetAutoTuneOptions(v *AutoTuneOptionsStatus) *DomainConfig
SetAutoTuneOptions sets the AutoTuneOptions field's value.
func (s *DomainConfig) SetChangeProgressDetails(v *ChangeProgressDetails) *DomainConfig
SetChangeProgressDetails sets the ChangeProgressDetails field's value.
func (s *DomainConfig) SetClusterConfig(v *ClusterConfigStatus) *DomainConfig
SetClusterConfig sets the ClusterConfig field's value.
func (s *DomainConfig) SetCognitoOptions(v *CognitoOptionsStatus) *DomainConfig
SetCognitoOptions sets the CognitoOptions field's value.
func (s *DomainConfig) SetDomainEndpointOptions(v *DomainEndpointOptionsStatus) *DomainConfig
SetDomainEndpointOptions sets the DomainEndpointOptions field's value.
func (s *DomainConfig) SetEBSOptions(v *EBSOptionsStatus) *DomainConfig
SetEBSOptions sets the EBSOptions field's value.
func (s *DomainConfig) SetEncryptionAtRestOptions(v *EncryptionAtRestOptionsStatus) *DomainConfig
SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.
func (s *DomainConfig) SetEngineVersion(v *VersionStatus) *DomainConfig
SetEngineVersion sets the EngineVersion field's value.
func (s *DomainConfig) SetLogPublishingOptions(v *LogPublishingOptionsStatus) *DomainConfig
SetLogPublishingOptions sets the LogPublishingOptions field's value.
func (s *DomainConfig) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptionsStatus) *DomainConfig
SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.
func (s *DomainConfig) SetOffPeakWindowOptions(v *OffPeakWindowOptionsStatus) *DomainConfig
SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.
func (s *DomainConfig) SetSnapshotOptions(v *SnapshotOptionsStatus) *DomainConfig
SetSnapshotOptions sets the SnapshotOptions field's value.
func (s *DomainConfig) SetSoftwareUpdateOptions(v *SoftwareUpdateOptionsStatus) *DomainConfig
SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.
func (s *DomainConfig) SetVPCOptions(v *VPCDerivedInfoStatus) *DomainConfig
SetVPCOptions sets the VPCOptions field's value.
func (s DomainConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainEndpointOptions struct { // The fully qualified URL for the custom endpoint. CustomEndpoint *string `min:"1" type:"string"` // The ARN for your security certificate, managed in Amazon Web Services Certificate // Manager (ACM). CustomEndpointCertificateArn *string `min:"20" type:"string"` // Whether to enable a custom endpoint for the domain. CustomEndpointEnabled *bool `type:"boolean"` // True to require that all traffic to the domain arrive over HTTPS. EnforceHTTPS *bool `type:"boolean"` // Specify the TLS security policy to apply to the HTTPS endpoint of the domain. // // Can be one of the following values: // // * Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version // 1.0 and higher. // // * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only // TLS version 1.2 TLSSecurityPolicy *string `type:"string" enum:"TLSSecurityPolicy"` // contains filtered or unexported fields }
Options to configure a custom endpoint for an OpenSearch Service domain.
func (s DomainEndpointOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainEndpointOptions) SetCustomEndpoint(v string) *DomainEndpointOptions
SetCustomEndpoint sets the CustomEndpoint field's value.
func (s *DomainEndpointOptions) SetCustomEndpointCertificateArn(v string) *DomainEndpointOptions
SetCustomEndpointCertificateArn sets the CustomEndpointCertificateArn field's value.
func (s *DomainEndpointOptions) SetCustomEndpointEnabled(v bool) *DomainEndpointOptions
SetCustomEndpointEnabled sets the CustomEndpointEnabled field's value.
func (s *DomainEndpointOptions) SetEnforceHTTPS(v bool) *DomainEndpointOptions
SetEnforceHTTPS sets the EnforceHTTPS field's value.
func (s *DomainEndpointOptions) SetTLSSecurityPolicy(v string) *DomainEndpointOptions
SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.
func (s DomainEndpointOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainEndpointOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DomainEndpointOptionsStatus struct { // Options to configure the endpoint for a domain. // // Options is a required field Options *DomainEndpointOptions `type:"structure" required:"true"` // The status of the endpoint options for a domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The configured endpoint options for a domain and their current status.
func (s DomainEndpointOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainEndpointOptionsStatus) SetOptions(v *DomainEndpointOptions) *DomainEndpointOptionsStatus
SetOptions sets the Options field's value.
func (s *DomainEndpointOptionsStatus) SetStatus(v *OptionStatus) *DomainEndpointOptionsStatus
SetStatus sets the Status field's value.
func (s DomainEndpointOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainInfo struct { // Name of the domain. DomainName *string `min:"3" type:"string"` // The type of search engine that the domain is running.OpenSearch for an OpenSearch // engine, or Elasticsearch for a legacy Elasticsearch OSS engine. EngineType *string `type:"string" enum:"EngineType"` // contains filtered or unexported fields }
Information about an OpenSearch Service domain.
func (s DomainInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainInfo) SetDomainName(v string) *DomainInfo
SetDomainName sets the DomainName field's value.
func (s *DomainInfo) SetEngineType(v string) *DomainInfo
SetEngineType sets the EngineType field's value.
func (s DomainInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainInformationContainer struct { // Information about an Amazon OpenSearch Service domain. AWSDomainInformation *AWSDomainInformation `type:"structure"` // contains filtered or unexported fields }
Container for information about an OpenSearch Service domain.
func (s DomainInformationContainer) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainInformationContainer) SetAWSDomainInformation(v *AWSDomainInformation) *DomainInformationContainer
SetAWSDomainInformation sets the AWSDomainInformation field's value.
func (s DomainInformationContainer) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainInformationContainer) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DomainNodesStatus struct { // The Availability Zone of the node. AvailabilityZone *string `min:"1" type:"string"` // The instance type information of the node. InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"` // The ID of the node. NodeId *string `min:"10" type:"string"` // Indicates if the node is active or in standby. NodeStatus *string `type:"string" enum:"NodeStatus"` // Indicates whether the nodes is a data, master, or ultrawarm node. NodeType *string `type:"string" enum:"NodeType"` // The storage size of the node, in GiB. StorageSize *string `type:"string"` // Indicates if the node has EBS or instance storage. StorageType *string `type:"string"` // If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. // Only applicable for data nodes. StorageVolumeType *string `type:"string" enum:"VolumeType"` // contains filtered or unexported fields }
Container for information about nodes on the domain.
func (s DomainNodesStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainNodesStatus) SetAvailabilityZone(v string) *DomainNodesStatus
SetAvailabilityZone sets the AvailabilityZone field's value.
func (s *DomainNodesStatus) SetInstanceType(v string) *DomainNodesStatus
SetInstanceType sets the InstanceType field's value.
func (s *DomainNodesStatus) SetNodeId(v string) *DomainNodesStatus
SetNodeId sets the NodeId field's value.
func (s *DomainNodesStatus) SetNodeStatus(v string) *DomainNodesStatus
SetNodeStatus sets the NodeStatus field's value.
func (s *DomainNodesStatus) SetNodeType(v string) *DomainNodesStatus
SetNodeType sets the NodeType field's value.
func (s *DomainNodesStatus) SetStorageSize(v string) *DomainNodesStatus
SetStorageSize sets the StorageSize field's value.
func (s *DomainNodesStatus) SetStorageType(v string) *DomainNodesStatus
SetStorageType sets the StorageType field's value.
func (s *DomainNodesStatus) SetStorageVolumeType(v string) *DomainNodesStatus
SetStorageVolumeType sets the StorageVolumeType field's value.
func (s DomainNodesStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainPackageDetails struct { // Name of the domain that the package is associated with. DomainName *string `min:"3" type:"string"` // State of the association. DomainPackageStatus *string `type:"string" enum:"DomainPackageStatus"` // Additional information if the package is in an error state. Null otherwise. ErrorDetails *ErrorDetails `type:"structure"` // Timestamp of the most recent update to the package association status. LastUpdated *time.Time `type:"timestamp"` // Internal ID of the package. PackageID *string `type:"string"` // User-specified name of the package. PackageName *string `min:"3" type:"string"` // The type of package. PackageType *string `type:"string" enum:"PackageType"` // The current version of the package. PackageVersion *string `type:"string"` // The relative path of the package on the OpenSearch Service cluster nodes. // This is synonym_path when the package is for synonym files. ReferencePath *string `type:"string"` // contains filtered or unexported fields }
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
func (s DomainPackageDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainPackageDetails) SetDomainName(v string) *DomainPackageDetails
SetDomainName sets the DomainName field's value.
func (s *DomainPackageDetails) SetDomainPackageStatus(v string) *DomainPackageDetails
SetDomainPackageStatus sets the DomainPackageStatus field's value.
func (s *DomainPackageDetails) SetErrorDetails(v *ErrorDetails) *DomainPackageDetails
SetErrorDetails sets the ErrorDetails field's value.
func (s *DomainPackageDetails) SetLastUpdated(v time.Time) *DomainPackageDetails
SetLastUpdated sets the LastUpdated field's value.
func (s *DomainPackageDetails) SetPackageID(v string) *DomainPackageDetails
SetPackageID sets the PackageID field's value.
func (s *DomainPackageDetails) SetPackageName(v string) *DomainPackageDetails
SetPackageName sets the PackageName field's value.
func (s *DomainPackageDetails) SetPackageType(v string) *DomainPackageDetails
SetPackageType sets the PackageType field's value.
func (s *DomainPackageDetails) SetPackageVersion(v string) *DomainPackageDetails
SetPackageVersion sets the PackageVersion field's value.
func (s *DomainPackageDetails) SetReferencePath(v string) *DomainPackageDetails
SetReferencePath sets the ReferencePath field's value.
func (s DomainPackageDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DomainStatus struct { // The Amazon Resource Name (ARN) of the domain. For more information, see IAM // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) // in the AWS Identity and Access Management User Guide. // // ARN is a required field ARN *string `min:"20" type:"string" required:"true"` // Identity and Access Management (IAM) policy document specifying the access // policies for the domain. AccessPolicies *string `type:"string"` // Key-value pairs that specify advanced configuration options. AdvancedOptions map[string]*string `type:"map"` // Settings for fine-grained access control. AdvancedSecurityOptions *AdvancedSecurityOptions `type:"structure"` // Auto-Tune settings for the domain. AutoTuneOptions *AutoTuneOptionsOutput_ `type:"structure"` // Information about a configuration change happening on the domain. ChangeProgressDetails *ChangeProgressDetails `type:"structure"` // Container for the cluster configuration of the domain. // // ClusterConfig is a required field ClusterConfig *ClusterConfig `type:"structure" required:"true"` // Key-value pairs to configure Amazon Cognito authentication for OpenSearch // Dashboards. CognitoOptions *CognitoOptions `type:"structure"` // Creation status of an OpenSearch Service domain. True if domain creation // is complete. False if domain creation is still in progress. Created *bool `type:"boolean"` // Deletion status of an OpenSearch Service domain. True if domain deletion // is complete. False if domain deletion is still in progress. Once deletion // is complete, the status of the domain is no longer returned. Deleted *bool `type:"boolean"` // Additional options for the domain endpoint, such as whether to require HTTPS // for all traffic. DomainEndpointOptions *DomainEndpointOptions `type:"structure"` // Unique identifier for the domain. // // DomainId is a required field DomainId *string `min:"1" type:"string" required:"true"` // Name of the domain. Domain names are unique across all domains owned by the // same account within an Amazon Web Services Region. // // DomainName is a required field DomainName *string `min:"3" type:"string" required:"true"` // Container for EBS-based storage settings for the domain. EBSOptions *EBSOptions `type:"structure"` // Encryption at rest settings for the domain. EncryptionAtRestOptions *EncryptionAtRestOptions `type:"structure"` // Domain-specific endpoint used to submit index, search, and data upload requests // to the domain. Endpoint *string `type:"string"` // The key-value pair that exists if the OpenSearch Service domain uses VPC // endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'. Endpoints map[string]*string `type:"map"` // Version of OpenSearch or Elasticsearch that the domain is running, in the // format Elasticsearch_X.Y or OpenSearch_X.Y. EngineVersion *string `min:"14" type:"string"` // Log publishing options for the domain. LogPublishingOptions map[string]*LogPublishingOption `type:"map"` // Whether node-to-node encryption is enabled or disabled. NodeToNodeEncryptionOptions *NodeToNodeEncryptionOptions `type:"structure"` // Options that specify a custom 10-hour window during which OpenSearch Service // can perform configuration changes on the domain. OffPeakWindowOptions *OffPeakWindowOptions `type:"structure"` // The status of the domain configuration. True if OpenSearch Service is processing // configuration changes. False if the configuration is active. Processing *bool `type:"boolean"` // The current status of the domain's service software. ServiceSoftwareOptions *ServiceSoftwareOptions `type:"structure"` // DEPRECATED. Container for parameters required to configure automated snapshots // of domain indexes. SnapshotOptions *SnapshotOptions `type:"structure"` // Service software update options for the domain. SoftwareUpdateOptions *SoftwareUpdateOptions `type:"structure"` // The status of a domain version upgrade to a new version of OpenSearch or // Elasticsearch. True if OpenSearch Service is in the process of a version // upgrade. False if the configuration is active. UpgradeProcessing *bool `type:"boolean"` // The VPC configuration for the domain. VPCOptions *VPCDerivedInfo `type:"structure"` // contains filtered or unexported fields }
The current status of an OpenSearch Service domain.
func (s DomainStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DomainStatus) SetARN(v string) *DomainStatus
SetARN sets the ARN field's value.
func (s *DomainStatus) SetAccessPolicies(v string) *DomainStatus
SetAccessPolicies sets the AccessPolicies field's value.
func (s *DomainStatus) SetAdvancedOptions(v map[string]*string) *DomainStatus
SetAdvancedOptions sets the AdvancedOptions field's value.
func (s *DomainStatus) SetAdvancedSecurityOptions(v *AdvancedSecurityOptions) *DomainStatus
SetAdvancedSecurityOptions sets the AdvancedSecurityOptions field's value.
func (s *DomainStatus) SetAutoTuneOptions(v *AutoTuneOptionsOutput_) *DomainStatus
SetAutoTuneOptions sets the AutoTuneOptions field's value.
func (s *DomainStatus) SetChangeProgressDetails(v *ChangeProgressDetails) *DomainStatus
SetChangeProgressDetails sets the ChangeProgressDetails field's value.
func (s *DomainStatus) SetClusterConfig(v *ClusterConfig) *DomainStatus
SetClusterConfig sets the ClusterConfig field's value.
func (s *DomainStatus) SetCognitoOptions(v *CognitoOptions) *DomainStatus
SetCognitoOptions sets the CognitoOptions field's value.
func (s *DomainStatus) SetCreated(v bool) *DomainStatus
SetCreated sets the Created field's value.
func (s *DomainStatus) SetDeleted(v bool) *DomainStatus
SetDeleted sets the Deleted field's value.
func (s *DomainStatus) SetDomainEndpointOptions(v *DomainEndpointOptions) *DomainStatus
SetDomainEndpointOptions sets the DomainEndpointOptions field's value.
func (s *DomainStatus) SetDomainId(v string) *DomainStatus
SetDomainId sets the DomainId field's value.
func (s *DomainStatus) SetDomainName(v string) *DomainStatus
SetDomainName sets the DomainName field's value.
func (s *DomainStatus) SetEBSOptions(v *EBSOptions) *DomainStatus
SetEBSOptions sets the EBSOptions field's value.
func (s *DomainStatus) SetEncryptionAtRestOptions(v *EncryptionAtRestOptions) *DomainStatus
SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.
func (s *DomainStatus) SetEndpoint(v string) *DomainStatus
SetEndpoint sets the Endpoint field's value.
func (s *DomainStatus) SetEndpoints(v map[string]*string) *DomainStatus
SetEndpoints sets the Endpoints field's value.
func (s *DomainStatus) SetEngineVersion(v string) *DomainStatus
SetEngineVersion sets the EngineVersion field's value.
func (s *DomainStatus) SetLogPublishingOptions(v map[string]*LogPublishingOption) *DomainStatus
SetLogPublishingOptions sets the LogPublishingOptions field's value.
func (s *DomainStatus) SetNodeToNodeEncryptionOptions(v *NodeToNodeEncryptionOptions) *DomainStatus
SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.
func (s *DomainStatus) SetOffPeakWindowOptions(v *OffPeakWindowOptions) *DomainStatus
SetOffPeakWindowOptions sets the OffPeakWindowOptions field's value.
func (s *DomainStatus) SetProcessing(v bool) *DomainStatus
SetProcessing sets the Processing field's value.
func (s *DomainStatus) SetServiceSoftwareOptions(v *ServiceSoftwareOptions) *DomainStatus
SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.
func (s *DomainStatus) SetSnapshotOptions(v *SnapshotOptions) *DomainStatus
SetSnapshotOptions sets the SnapshotOptions field's value.
func (s *DomainStatus) SetSoftwareUpdateOptions(v *SoftwareUpdateOptions) *DomainStatus
SetSoftwareUpdateOptions sets the SoftwareUpdateOptions field's value.
func (s *DomainStatus) SetUpgradeProcessing(v bool) *DomainStatus
SetUpgradeProcessing sets the UpgradeProcessing field's value.
func (s *DomainStatus) SetVPCOptions(v *VPCDerivedInfo) *DomainStatus
SetVPCOptions sets the VPCOptions field's value.
func (s DomainStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DryRunProgressStatus struct { // The timestamp when the dry run was initiated. // // CreationDate is a required field CreationDate *string `type:"string" required:"true"` // The unique identifier of the dry run. // // DryRunId is a required field DryRunId *string `min:"36" type:"string" required:"true"` // The current status of the dry run. // // DryRunStatus is a required field DryRunStatus *string `type:"string" required:"true"` // The timestamp when the dry run was last updated. // // UpdateDate is a required field UpdateDate *string `type:"string" required:"true"` // Any validation failures that occurred as a result of the dry run. ValidationFailures []*ValidationFailure `type:"list"` // contains filtered or unexported fields }
Information about the progress of a pre-upgrade dry run analysis.
func (s DryRunProgressStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DryRunProgressStatus) SetCreationDate(v string) *DryRunProgressStatus
SetCreationDate sets the CreationDate field's value.
func (s *DryRunProgressStatus) SetDryRunId(v string) *DryRunProgressStatus
SetDryRunId sets the DryRunId field's value.
func (s *DryRunProgressStatus) SetDryRunStatus(v string) *DryRunProgressStatus
SetDryRunStatus sets the DryRunStatus field's value.
func (s *DryRunProgressStatus) SetUpdateDate(v string) *DryRunProgressStatus
SetUpdateDate sets the UpdateDate field's value.
func (s *DryRunProgressStatus) SetValidationFailures(v []*ValidationFailure) *DryRunProgressStatus
SetValidationFailures sets the ValidationFailures field's value.
func (s DryRunProgressStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DryRunResults struct { // Specifies the way in which OpenSearch Service will apply an update. Possible // values are: // // * Blue/Green - The update requires a blue/green deployment. // // * DynamicUpdate - No blue/green deployment required // // * Undetermined - The domain is in the middle of an update and can't predict // the deployment type. Try again after the update is complete. // // * None - The request doesn't include any configuration changes. DeploymentType *string `min:"2" type:"string"` // A message corresponding to the deployment type. Message *string `type:"string"` // contains filtered or unexported fields }
Results of a dry run performed in an update domain request.
func (s DryRunResults) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DryRunResults) SetDeploymentType(v string) *DryRunResults
SetDeploymentType sets the DeploymentType field's value.
func (s *DryRunResults) SetMessage(v string) *DryRunResults
SetMessage sets the Message field's value.
func (s DryRunResults) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Duration struct { // The unit of measurement for the duration of a maintenance schedule. Unit *string `type:"string" enum:"TimeUnit"` // Integer to specify the value of a maintenance schedule duration. Value *int64 `min:"1" type:"long"` // contains filtered or unexported fields }
The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
func (s Duration) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Duration) SetUnit(v string) *Duration
SetUnit sets the Unit field's value.
func (s *Duration) SetValue(v int64) *Duration
SetValue sets the Value field's value.
func (s Duration) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Duration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EBSOptions struct { // Indicates whether EBS volumes are attached to data nodes in an OpenSearch // Service domain. EBSEnabled *bool `type:"boolean"` // Specifies the baseline input/output (I/O) performance of EBS volumes attached // to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume // types. Iops *int64 `type:"integer"` // Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. // Applicable only for the gp3 volume type. Throughput *int64 `type:"integer"` // Specifies the size (in GiB) of EBS volumes attached to data nodes. VolumeSize *int64 `type:"integer"` // Specifies the type of EBS volumes attached to data nodes. VolumeType *string `type:"string" enum:"VolumeType"` // contains filtered or unexported fields }
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
func (s EBSOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EBSOptions) SetEBSEnabled(v bool) *EBSOptions
SetEBSEnabled sets the EBSEnabled field's value.
func (s *EBSOptions) SetIops(v int64) *EBSOptions
SetIops sets the Iops field's value.
func (s *EBSOptions) SetThroughput(v int64) *EBSOptions
SetThroughput sets the Throughput field's value.
func (s *EBSOptions) SetVolumeSize(v int64) *EBSOptions
SetVolumeSize sets the VolumeSize field's value.
func (s *EBSOptions) SetVolumeType(v string) *EBSOptions
SetVolumeType sets the VolumeType field's value.
func (s EBSOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EBSOptionsStatus struct { // The configured EBS options for the specified domain. // // Options is a required field Options *EBSOptions `type:"structure" required:"true"` // The status of the EBS options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
The status of the EBS options for the specified OpenSearch Service domain.
func (s EBSOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EBSOptionsStatus) SetOptions(v *EBSOptions) *EBSOptionsStatus
SetOptions sets the Options field's value.
func (s *EBSOptionsStatus) SetStatus(v *OptionStatus) *EBSOptionsStatus
SetStatus sets the Status field's value.
func (s EBSOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EncryptionAtRestOptions struct { // True to enable encryption at rest. Enabled *bool `type:"boolean"` // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. KmsKeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.
func (s EncryptionAtRestOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EncryptionAtRestOptions) SetEnabled(v bool) *EncryptionAtRestOptions
SetEnabled sets the Enabled field's value.
func (s *EncryptionAtRestOptions) SetKmsKeyId(v string) *EncryptionAtRestOptions
SetKmsKeyId sets the KmsKeyId field's value.
func (s EncryptionAtRestOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EncryptionAtRestOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EncryptionAtRestOptionsStatus struct { // Encryption at rest options for the specified domain. // // Options is a required field Options *EncryptionAtRestOptions `type:"structure" required:"true"` // The status of the encryption at rest options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
Status of the encryption at rest options for the specified OpenSearch Service domain.
func (s EncryptionAtRestOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EncryptionAtRestOptionsStatus) SetOptions(v *EncryptionAtRestOptions) *EncryptionAtRestOptionsStatus
SetOptions sets the Options field's value.
func (s *EncryptionAtRestOptionsStatus) SetStatus(v *OptionStatus) *EncryptionAtRestOptionsStatus
SetStatus sets the Status field's value.
func (s EncryptionAtRestOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnvironmentInfo struct { // A list of AvailabilityZoneInfo for the domain. AvailabilityZoneInformation []*AvailabilityZoneInfo `type:"list"` // contains filtered or unexported fields }
Information about the active domain environment.
func (s EnvironmentInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EnvironmentInfo) SetAvailabilityZoneInformation(v []*AvailabilityZoneInfo) *EnvironmentInfo
SetAvailabilityZoneInformation sets the AvailabilityZoneInformation field's value.
func (s EnvironmentInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ErrorDetails struct { // A message describing the error. ErrorMessage *string `type:"string"` // The type of error that occurred. ErrorType *string `type:"string"` // contains filtered or unexported fields }
Additional information if the package is in an error state. Null otherwise.
func (s ErrorDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ErrorDetails) SetErrorMessage(v string) *ErrorDetails
SetErrorMessage sets the ErrorMessage field's value.
func (s *ErrorDetails) SetErrorType(v string) *ErrorDetails
SetErrorType sets the ErrorType field's value.
func (s ErrorDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Filter struct { // The name of the filter. Name *string `min:"1" type:"string"` // One or more values for the filter. Values []*string `min:"1" type:"list"` // contains filtered or unexported fields }
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
func (s Filter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Filter) SetName(v string) *Filter
SetName sets the Name field's value.
func (s *Filter) SetValues(v []*string) *Filter
SetValues sets the Values field's value.
func (s Filter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Filter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCompatibleVersionsInput struct { // The name of an existing domain. Provide this parameter to limit the results // to a single domain. DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to GetCompatibleVersions operation.
func (s GetCompatibleVersionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetCompatibleVersionsInput) SetDomainName(v string) *GetCompatibleVersionsInput
SetDomainName sets the DomainName field's value.
func (s GetCompatibleVersionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetCompatibleVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCompatibleVersionsOutput struct { // A map of OpenSearch or Elasticsearch versions and the versions you can upgrade // them to. CompatibleVersions []*CompatibleVersionsMap `type:"list"` // contains filtered or unexported fields }
Container for the response returned by the GetCompatibleVersions operation.
func (s GetCompatibleVersionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetCompatibleVersionsOutput) SetCompatibleVersions(v []*CompatibleVersionsMap) *GetCompatibleVersionsOutput
SetCompatibleVersions sets the CompatibleVersions field's value.
func (s GetCompatibleVersionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetPackageVersionHistoryInput struct { // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial GetPackageVersionHistory operation returns a nextToken, you // can include the returned nextToken in subsequent GetPackageVersionHistory // operations, which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // The unique identifier of the package. // // PackageID is a required field PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to the GetPackageVersionHistory operation.
func (s GetPackageVersionHistoryInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPackageVersionHistoryInput) SetMaxResults(v int64) *GetPackageVersionHistoryInput
SetMaxResults sets the MaxResults field's value.
func (s *GetPackageVersionHistoryInput) SetNextToken(v string) *GetPackageVersionHistoryInput
SetNextToken sets the NextToken field's value.
func (s *GetPackageVersionHistoryInput) SetPackageID(v string) *GetPackageVersionHistoryInput
SetPackageID sets the PackageID field's value.
func (s GetPackageVersionHistoryInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPackageVersionHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPackageVersionHistoryOutput struct { // When 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. NextToken *string `type:"string"` // The unique identifier of the package. PackageID *string `type:"string"` // A list of package versions, along with their creation time and commit message. PackageVersionHistoryList []*PackageVersionHistory `type:"list"` // contains filtered or unexported fields }
Container for response returned by GetPackageVersionHistory operation.
func (s GetPackageVersionHistoryOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetPackageVersionHistoryOutput) SetNextToken(v string) *GetPackageVersionHistoryOutput
SetNextToken sets the NextToken field's value.
func (s *GetPackageVersionHistoryOutput) SetPackageID(v string) *GetPackageVersionHistoryOutput
SetPackageID sets the PackageID field's value.
func (s *GetPackageVersionHistoryOutput) SetPackageVersionHistoryList(v []*PackageVersionHistory) *GetPackageVersionHistoryOutput
SetPackageVersionHistoryList sets the PackageVersionHistoryList field's value.
func (s GetPackageVersionHistoryOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetUpgradeHistoryInput struct { // The name of an existing domain. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial GetUpgradeHistory operation returns a nextToken, you can // include the returned nextToken in subsequent GetUpgradeHistory operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to the GetUpgradeHistory operation.
func (s GetUpgradeHistoryInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeHistoryInput) SetDomainName(v string) *GetUpgradeHistoryInput
SetDomainName sets the DomainName field's value.
func (s *GetUpgradeHistoryInput) SetMaxResults(v int64) *GetUpgradeHistoryInput
SetMaxResults sets the MaxResults field's value.
func (s *GetUpgradeHistoryInput) SetNextToken(v string) *GetUpgradeHistoryInput
SetNextToken sets the NextToken field's value.
func (s GetUpgradeHistoryInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUpgradeHistoryOutput struct { // When 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. NextToken *string `type:"string"` // A list of objects corresponding to each upgrade or upgrade eligibility check // performed on a domain. UpgradeHistories []*UpgradeHistory `type:"list"` // contains filtered or unexported fields }
Container for the response returned by the GetUpgradeHistory operation.
func (s GetUpgradeHistoryOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeHistoryOutput) SetNextToken(v string) *GetUpgradeHistoryOutput
SetNextToken sets the NextToken field's value.
func (s *GetUpgradeHistoryOutput) SetUpgradeHistories(v []*UpgradeHistory) *GetUpgradeHistoryOutput
SetUpgradeHistories sets the UpgradeHistories field's value.
func (s GetUpgradeHistoryOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetUpgradeStatusInput struct { // The domain of the domain to get upgrade status information for. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to the GetUpgradeStatus operation.
func (s GetUpgradeStatusInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeStatusInput) SetDomainName(v string) *GetUpgradeStatusInput
SetDomainName sets the DomainName field's value.
func (s GetUpgradeStatusInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUpgradeStatusOutput struct { // The status of the current step that an upgrade is on. StepStatus *string `type:"string" enum:"UpgradeStatus"` // A string that describes the update. UpgradeName *string `type:"string"` // One of three steps that an upgrade or upgrade eligibility check goes through. UpgradeStep *string `type:"string" enum:"UpgradeStep"` // contains filtered or unexported fields }
Container for the response returned by the GetUpgradeStatus operation.
func (s GetUpgradeStatusOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUpgradeStatusOutput) SetStepStatus(v string) *GetUpgradeStatusOutput
SetStepStatus sets the StepStatus field's value.
func (s *GetUpgradeStatusOutput) SetUpgradeName(v string) *GetUpgradeStatusOutput
SetUpgradeName sets the UpgradeName field's value.
func (s *GetUpgradeStatusOutput) SetUpgradeStep(v string) *GetUpgradeStatusOutput
SetUpgradeStep sets the UpgradeStep field's value.
func (s GetUpgradeStatusOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InboundConnection struct { // The unique identifier of the connection. ConnectionId *string `min:"10" type:"string"` // The connection mode. ConnectionMode *string `type:"string" enum:"ConnectionMode"` // The current status of the connection. ConnectionStatus *InboundConnectionStatus `type:"structure"` // Information about the source (local) domain. LocalDomainInfo *DomainInformationContainer `type:"structure"` // Information about the destination (remote) domain. RemoteDomainInfo *DomainInformationContainer `type:"structure"` // contains filtered or unexported fields }
Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
func (s InboundConnection) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InboundConnection) SetConnectionId(v string) *InboundConnection
SetConnectionId sets the ConnectionId field's value.
func (s *InboundConnection) SetConnectionMode(v string) *InboundConnection
SetConnectionMode sets the ConnectionMode field's value.
func (s *InboundConnection) SetConnectionStatus(v *InboundConnectionStatus) *InboundConnection
SetConnectionStatus sets the ConnectionStatus field's value.
func (s *InboundConnection) SetLocalDomainInfo(v *DomainInformationContainer) *InboundConnection
SetLocalDomainInfo sets the LocalDomainInfo field's value.
func (s *InboundConnection) SetRemoteDomainInfo(v *DomainInformationContainer) *InboundConnection
SetRemoteDomainInfo sets the RemoteDomainInfo field's value.
func (s InboundConnection) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InboundConnectionStatus struct { // Information about the connection. Message *string `type:"string"` // The status code for the connection. Can be one of the following: // // * PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote // domain owner. // // * APPROVED: Inbound connection is pending acceptance by the remote domain // owner. // // * PROVISIONING: Inbound connection is being provisioned. // // * ACTIVE: Inbound connection is active and ready to use. // // * REJECTING: Inbound connection rejection is in process. // // * REJECTED: Inbound connection is rejected. // // * DELETING: Inbound connection deletion is in progress. // // * DELETED: Inbound connection is deleted and can no longer be used. StatusCode *string `type:"string" enum:"InboundConnectionStatusCode"` // contains filtered or unexported fields }
The status of an inbound cross-cluster connection for OpenSearch Service.
func (s InboundConnectionStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InboundConnectionStatus) SetMessage(v string) *InboundConnectionStatus
SetMessage sets the Message field's value.
func (s *InboundConnectionStatus) SetStatusCode(v string) *InboundConnectionStatus
SetStatusCode sets the StatusCode field's value.
func (s InboundConnectionStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InstanceCountLimits struct { // The minimum allowed number of instances. MaximumInstanceCount *int64 `type:"integer"` // The maximum allowed number of instances. MinimumInstanceCount *int64 `type:"integer"` // contains filtered or unexported fields }
Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
func (s InstanceCountLimits) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceCountLimits) SetMaximumInstanceCount(v int64) *InstanceCountLimits
SetMaximumInstanceCount sets the MaximumInstanceCount field's value.
func (s *InstanceCountLimits) SetMinimumInstanceCount(v int64) *InstanceCountLimits
SetMinimumInstanceCount sets the MinimumInstanceCount field's value.
func (s InstanceCountLimits) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InstanceLimits struct { // Limits on the number of instances that can be created for a given instance // type. InstanceCountLimits *InstanceCountLimits `type:"structure"` // contains filtered or unexported fields }
Instance-related attributes that are available for a given instance type.
func (s InstanceLimits) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceLimits) SetInstanceCountLimits(v *InstanceCountLimits) *InstanceLimits
SetInstanceCountLimits sets the InstanceCountLimits field's value.
func (s InstanceLimits) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InstanceTypeDetails struct { // Whether fine-grained access control is supported for the instance type. AdvancedSecurityEnabled *bool `type:"boolean"` // Whether logging is supported for the instance type. AppLogsEnabled *bool `type:"boolean"` // The supported Availability Zones for the instance type. AvailabilityZones []*string `type:"list"` // Whether Amazon Cognito access is supported for the instance type. CognitoEnabled *bool `type:"boolean"` // Whether encryption at rest and node-to-node encryption are supported for // the instance type. EncryptionEnabled *bool `type:"boolean"` // Whether the instance acts as a data node, a dedicated master node, or an // UltraWarm node. InstanceRole []*string `type:"list"` // The instance type. InstanceType *string `type:"string" enum:"OpenSearchPartitionInstanceType"` // Whether UltraWarm is supported for the instance type. WarmEnabled *bool `type:"boolean"` // contains filtered or unexported fields }
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
func (s InstanceTypeDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceTypeDetails) SetAdvancedSecurityEnabled(v bool) *InstanceTypeDetails
SetAdvancedSecurityEnabled sets the AdvancedSecurityEnabled field's value.
func (s *InstanceTypeDetails) SetAppLogsEnabled(v bool) *InstanceTypeDetails
SetAppLogsEnabled sets the AppLogsEnabled field's value.
func (s *InstanceTypeDetails) SetAvailabilityZones(v []*string) *InstanceTypeDetails
SetAvailabilityZones sets the AvailabilityZones field's value.
func (s *InstanceTypeDetails) SetCognitoEnabled(v bool) *InstanceTypeDetails
SetCognitoEnabled sets the CognitoEnabled field's value.
func (s *InstanceTypeDetails) SetEncryptionEnabled(v bool) *InstanceTypeDetails
SetEncryptionEnabled sets the EncryptionEnabled field's value.
func (s *InstanceTypeDetails) SetInstanceRole(v []*string) *InstanceTypeDetails
SetInstanceRole sets the InstanceRole field's value.
func (s *InstanceTypeDetails) SetInstanceType(v string) *InstanceTypeDetails
SetInstanceType sets the InstanceType field's value.
func (s *InstanceTypeDetails) SetWarmEnabled(v bool) *InstanceTypeDetails
SetWarmEnabled sets the WarmEnabled field's value.
func (s InstanceTypeDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Request processing failed because of an unknown error, exception, or internal failure.
func (s *InternalException) Code() string
Code returns the exception type name.
func (s *InternalException) Error() string
func (s InternalException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalException) Message() string
Message returns the exception's message.
func (s *InternalException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidPaginationTokenException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Request processing failed because you provided an invalid pagination token.
func (s *InvalidPaginationTokenException) Code() string
Code returns the exception type name.
func (s *InvalidPaginationTokenException) Error() string
func (s InvalidPaginationTokenException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidPaginationTokenException) Message() string
Message returns the exception's message.
func (s *InvalidPaginationTokenException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidPaginationTokenException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidPaginationTokenException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidPaginationTokenException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidTypeException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An exception for trying to create or access a sub-resource that's either invalid or not supported.
func (s *InvalidTypeException) Code() string
Code returns the exception type name.
func (s *InvalidTypeException) Error() string
func (s InvalidTypeException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidTypeException) Message() string
Message returns the exception's message.
func (s *InvalidTypeException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidTypeException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidTypeException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidTypeException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An exception for trying to create more than the allowed number of resources or sub-resources.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Limits struct { // List of additional limits that are specific to a given instance type for // each of its instance roles. AdditionalLimits []*AdditionalLimit `type:"list"` // The limits for a given instance type. InstanceLimits *InstanceLimits `type:"structure"` // Storage-related attributes that are available for a given instance type. StorageTypes []*StorageType `type:"list"` // contains filtered or unexported fields }
Limits for a given instance type and for each of its roles.
func (s Limits) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Limits) SetAdditionalLimits(v []*AdditionalLimit) *Limits
SetAdditionalLimits sets the AdditionalLimits field's value.
func (s *Limits) SetInstanceLimits(v *InstanceLimits) *Limits
SetInstanceLimits sets the InstanceLimits field's value.
func (s *Limits) SetStorageTypes(v []*StorageType) *Limits
SetStorageTypes sets the StorageTypes field's value.
func (s Limits) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDomainNamesInput struct { // Filters the output by domain engine type. EngineType *string `location:"querystring" locationName:"engineType" type:"string" enum:"EngineType"` // contains filtered or unexported fields }
Container for the parameters to the ListDomainNames operation.
func (s ListDomainNamesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDomainNamesInput) SetEngineType(v string) *ListDomainNamesInput
SetEngineType sets the EngineType field's value.
func (s ListDomainNamesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDomainNamesOutput struct { // The names of all OpenSearch Service domains owned by the current user and // their respective engine types. DomainNames []*DomainInfo `type:"list"` // contains filtered or unexported fields }
The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
func (s ListDomainNamesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDomainNamesOutput) SetDomainNames(v []*DomainInfo) *ListDomainNamesOutput
SetDomainNames sets the DomainNames field's value.
func (s ListDomainNamesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListDomainsForPackageInput struct { // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial ListDomainsForPackage operation returns a nextToken, you // can include the returned nextToken in subsequent ListDomainsForPackage operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // The unique identifier of the package for which to list associated domains. // // PackageID is a required field PackageID *string `location:"uri" locationName:"PackageID" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the request parameters to the ListDomainsForPackage operation.
func (s ListDomainsForPackageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDomainsForPackageInput) SetMaxResults(v int64) *ListDomainsForPackageInput
SetMaxResults sets the MaxResults field's value.
func (s *ListDomainsForPackageInput) SetNextToken(v string) *ListDomainsForPackageInput
SetNextToken sets the NextToken field's value.
func (s *ListDomainsForPackageInput) SetPackageID(v string) *ListDomainsForPackageInput
SetPackageID sets the PackageID field's value.
func (s ListDomainsForPackageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDomainsForPackageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDomainsForPackageOutput struct { // Information about all domains associated with a package. DomainPackageDetailsList []*DomainPackageDetails `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the response parameters to the ListDomainsForPackage operation.
func (s ListDomainsForPackageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDomainsForPackageOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListDomainsForPackageOutput
SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.
func (s *ListDomainsForPackageOutput) SetNextToken(v string) *ListDomainsForPackageOutput
SetNextToken sets the NextToken field's value.
func (s ListDomainsForPackageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListInstanceTypeDetailsInput struct { // The name of the domain. DomainName *string `location:"querystring" locationName:"domainName" min:"3" type:"string"` // The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y // or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. // // EngineVersion is a required field EngineVersion *string `location:"uri" locationName:"EngineVersion" min:"14" type:"string" required:"true"` // An optional parameter that lists information for a given instance type. InstanceType *string `location:"querystring" locationName:"instanceType" min:"10" type:"string"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial ListInstanceTypeDetails operation returns a nextToken, you // can include the returned nextToken in subsequent ListInstanceTypeDetails // operations, which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // An optional parameter that specifies the Availability Zones for the domain. RetrieveAZs *bool `location:"querystring" locationName:"retrieveAZs" type:"boolean"` // contains filtered or unexported fields }
func (s ListInstanceTypeDetailsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListInstanceTypeDetailsInput) SetDomainName(v string) *ListInstanceTypeDetailsInput
SetDomainName sets the DomainName field's value.
func (s *ListInstanceTypeDetailsInput) SetEngineVersion(v string) *ListInstanceTypeDetailsInput
SetEngineVersion sets the EngineVersion field's value.
func (s *ListInstanceTypeDetailsInput) SetInstanceType(v string) *ListInstanceTypeDetailsInput
SetInstanceType sets the InstanceType field's value.
func (s *ListInstanceTypeDetailsInput) SetMaxResults(v int64) *ListInstanceTypeDetailsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListInstanceTypeDetailsInput) SetNextToken(v string) *ListInstanceTypeDetailsInput
SetNextToken sets the NextToken field's value.
func (s *ListInstanceTypeDetailsInput) SetRetrieveAZs(v bool) *ListInstanceTypeDetailsInput
SetRetrieveAZs sets the RetrieveAZs field's value.
func (s ListInstanceTypeDetailsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListInstanceTypeDetailsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListInstanceTypeDetailsOutput struct { // Lists all supported instance types and features for the given OpenSearch // or Elasticsearch version. InstanceTypeDetails []*InstanceTypeDetails `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (s ListInstanceTypeDetailsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListInstanceTypeDetailsOutput) SetInstanceTypeDetails(v []*InstanceTypeDetails) *ListInstanceTypeDetailsOutput
SetInstanceTypeDetails sets the InstanceTypeDetails field's value.
func (s *ListInstanceTypeDetailsOutput) SetNextToken(v string) *ListInstanceTypeDetailsOutput
SetNextToken sets the NextToken field's value.
func (s ListInstanceTypeDetailsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListPackagesForDomainInput struct { // The name of the domain for which you want to list associated packages. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial ListPackagesForDomain operation returns a nextToken, you // can include the returned nextToken in subsequent ListPackagesForDomain operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to the ListPackagesForDomain operation.
func (s ListPackagesForDomainInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPackagesForDomainInput) SetDomainName(v string) *ListPackagesForDomainInput
SetDomainName sets the DomainName field's value.
func (s *ListPackagesForDomainInput) SetMaxResults(v int64) *ListPackagesForDomainInput
SetMaxResults sets the MaxResults field's value.
func (s *ListPackagesForDomainInput) SetNextToken(v string) *ListPackagesForDomainInput
SetNextToken sets the NextToken field's value.
func (s ListPackagesForDomainInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPackagesForDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPackagesForDomainOutput struct { // List of all packages associated with a domain. DomainPackageDetailsList []*DomainPackageDetails `type:"list"` // When 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. NextToken *string `type:"string"` // contains filtered or unexported fields }
Container for the response parameters to the ListPackagesForDomain operation.
func (s ListPackagesForDomainOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListPackagesForDomainOutput) SetDomainPackageDetailsList(v []*DomainPackageDetails) *ListPackagesForDomainOutput
SetDomainPackageDetailsList sets the DomainPackageDetailsList field's value.
func (s *ListPackagesForDomainOutput) SetNextToken(v string) *ListPackagesForDomainOutput
SetNextToken sets the NextToken field's value.
func (s ListPackagesForDomainOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListScheduledActionsInput struct { // The name of the domain. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial ListScheduledActions operation returns a nextToken, you can // include the returned nextToken in subsequent ListScheduledActions operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (s ListScheduledActionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListScheduledActionsInput) SetDomainName(v string) *ListScheduledActionsInput
SetDomainName sets the DomainName field's value.
func (s *ListScheduledActionsInput) SetMaxResults(v int64) *ListScheduledActionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListScheduledActionsInput) SetNextToken(v string) *ListScheduledActionsInput
SetNextToken sets the NextToken field's value.
func (s ListScheduledActionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListScheduledActionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListScheduledActionsOutput struct { // When 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. NextToken *string `type:"string"` // A list of actions that are scheduled for the domain. ScheduledActions []*ScheduledAction `type:"list"` // contains filtered or unexported fields }
func (s ListScheduledActionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListScheduledActionsOutput) SetNextToken(v string) *ListScheduledActionsOutput
SetNextToken sets the NextToken field's value.
func (s *ListScheduledActionsOutput) SetScheduledActions(v []*ScheduledAction) *ListScheduledActionsOutput
SetScheduledActions sets the ScheduledActions field's value.
func (s ListScheduledActionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsInput struct { // Amazon Resource Name (ARN) for the domain to view tags for. // // ARN is a required field ARN *string `location:"querystring" locationName:"arn" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
Container for the parameters to the ListTags operation.
func (s ListTagsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsInput) SetARN(v string) *ListTagsInput
SetARN sets the ARN field's value.
func (s ListTagsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsOutput struct { // List of resource tags associated with the specified domain. TagList []*Tag `type:"list"` // contains filtered or unexported fields }
The results of a ListTags operation.
func (s ListTagsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput
SetTagList sets the TagList field's value.
func (s ListTagsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVersionsInput struct { // An optional parameter that specifies the maximum number of results to return. // You can use nextToken to get the next page of results. MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` // If your initial ListVersions operation returns a nextToken, you can include // the returned nextToken in subsequent ListVersions operations, which returns // results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Container for the request parameters to the ListVersions operation.
func (s ListVersionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVersionsInput) SetMaxResults(v int64) *ListVersionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListVersionsInput) SetNextToken(v string) *ListVersionsInput
SetNextToken sets the NextToken field's value.
func (s ListVersionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVersionsOutput struct { // When 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. NextToken *string `type:"string"` // A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch // Service supports. Versions []*string `type:"list"` // contains filtered or unexported fields }
Container for the parameters for response received from the ListVersions operation.
func (s ListVersionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVersionsOutput) SetNextToken(v string) *ListVersionsOutput
SetNextToken sets the NextToken field's value.
func (s *ListVersionsOutput) SetVersions(v []*string) *ListVersionsOutput
SetVersions sets the Versions field's value.
func (s ListVersionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVpcEndpointAccessInput struct { // The name of the OpenSearch Service domain to retrieve access information // for. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // If your initial ListVpcEndpointAccess operation returns a nextToken, you // can include the returned nextToken in subsequent ListVpcEndpointAccess operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (s ListVpcEndpointAccessInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointAccessInput) SetDomainName(v string) *ListVpcEndpointAccessInput
SetDomainName sets the DomainName field's value.
func (s *ListVpcEndpointAccessInput) SetNextToken(v string) *ListVpcEndpointAccessInput
SetNextToken sets the NextToken field's value.
func (s ListVpcEndpointAccessInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointAccessInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListVpcEndpointAccessOutput struct { // A list of IAM principals (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) // that can currently access the domain. // // AuthorizedPrincipalList is a required field AuthorizedPrincipalList []*AuthorizedPrincipal `type:"list" required:"true"` // When 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. // // NextToken is a required field NextToken *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListVpcEndpointAccessOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointAccessOutput) SetAuthorizedPrincipalList(v []*AuthorizedPrincipal) *ListVpcEndpointAccessOutput
SetAuthorizedPrincipalList sets the AuthorizedPrincipalList field's value.
func (s *ListVpcEndpointAccessOutput) SetNextToken(v string) *ListVpcEndpointAccessOutput
SetNextToken sets the NextToken field's value.
func (s ListVpcEndpointAccessOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVpcEndpointsForDomainInput struct { // The name of the domain to list associated VPC endpoints for. // // DomainName is a required field DomainName *string `location:"uri" locationName:"DomainName" min:"3" type:"string" required:"true"` // If your initial ListEndpointsForDomain operation returns a nextToken, you // can include the returned nextToken in subsequent ListEndpointsForDomain operations, // which returns results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (s ListVpcEndpointsForDomainInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointsForDomainInput) SetDomainName(v string) *ListVpcEndpointsForDomainInput
SetDomainName sets the DomainName field's value.
func (s *ListVpcEndpointsForDomainInput) SetNextToken(v string) *ListVpcEndpointsForDomainInput
SetNextToken sets the NextToken field's value.
func (s ListVpcEndpointsForDomainInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointsForDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListVpcEndpointsForDomainOutput struct { // When 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. // // NextToken is a required field NextToken *string `type:"string" required:"true"` // Information about each endpoint associated with the domain. // // VpcEndpointSummaryList is a required field VpcEndpointSummaryList []*VpcEndpointSummary `type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListVpcEndpointsForDomainOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointsForDomainOutput) SetNextToken(v string) *ListVpcEndpointsForDomainOutput
SetNextToken sets the NextToken field's value.
func (s *ListVpcEndpointsForDomainOutput) SetVpcEndpointSummaryList(v []*VpcEndpointSummary) *ListVpcEndpointsForDomainOutput
SetVpcEndpointSummaryList sets the VpcEndpointSummaryList field's value.
func (s ListVpcEndpointsForDomainOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVpcEndpointsInput struct { // If your initial ListVpcEndpoints operation returns a nextToken, you can include // the returned nextToken in subsequent ListVpcEndpoints operations, which returns // results in the next page. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (s ListVpcEndpointsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointsInput) SetNextToken(v string) *ListVpcEndpointsInput
SetNextToken sets the NextToken field's value.
func (s ListVpcEndpointsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListVpcEndpointsOutput struct { // When 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. // // NextToken is a required field NextToken *string `type:"string" required:"true"` // Information about each endpoint. // // VpcEndpointSummaryList is a required field VpcEndpointSummaryList []*VpcEndpointSummary `type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListVpcEndpointsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListVpcEndpointsOutput) SetNextToken(v string) *ListVpcEndpointsOutput
SetNextToken sets the NextToken field's value.
func (s *ListVpcEndpointsOutput) SetVpcEndpointSummaryList(v []*VpcEndpointSummary) *ListVpcEndpointsOutput
SetVpcEndpointSummaryList sets the VpcEndpointSummaryList field's value.
func (s ListVpcEndpointsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LogPublishingOption struct { // The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs // to. CloudWatchLogsLogGroupArn *string `min:"20" type:"string"` // Whether the log should be published. Enabled *bool `type:"boolean"` // contains filtered or unexported fields }
Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html).
After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.
func (s LogPublishingOption) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LogPublishingOption) SetCloudWatchLogsLogGroupArn(v string) *LogPublishingOption
SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.
func (s *LogPublishingOption) SetEnabled(v bool) *LogPublishingOption
SetEnabled sets the Enabled field's value.
func (s LogPublishingOption) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LogPublishingOption) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LogPublishingOptionsStatus struct { // The log publishing options configured for the domain. Options map[string]*LogPublishingOption `type:"map"` // The status of the log publishing options for the domain. Status *OptionStatus `type:"structure"` // contains filtered or unexported fields }
The configured log publishing options for the domain and their current status.
func (s LogPublishingOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LogPublishingOptionsStatus) SetOptions(v map[string]*LogPublishingOption) *LogPublishingOptionsStatus
SetOptions sets the Options field's value.
func (s *LogPublishingOptionsStatus) SetStatus(v *OptionStatus) *LogPublishingOptionsStatus
SetStatus sets the Status field's value.
func (s LogPublishingOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MasterUserOptions struct { // Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled // is false. MasterUserARN *string `min:"20" type:"string"` // User name for the master user. Only specify if InternalUserDatabaseEnabled // is true. // // MasterUserName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by MasterUserOptions's // String and GoString methods. MasterUserName *string `min:"1" type:"string" sensitive:"true"` // Password for the master user. Only specify if InternalUserDatabaseEnabled // is true. // // MasterUserPassword is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by MasterUserOptions's // String and GoString methods. MasterUserPassword *string `min:"8" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Credentials for the master user for a domain.
func (s MasterUserOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MasterUserOptions) SetMasterUserARN(v string) *MasterUserOptions
SetMasterUserARN sets the MasterUserARN field's value.
func (s *MasterUserOptions) SetMasterUserName(v string) *MasterUserOptions
SetMasterUserName sets the MasterUserName field's value.
func (s *MasterUserOptions) SetMasterUserPassword(v string) *MasterUserOptions
SetMasterUserPassword sets the MasterUserPassword field's value.
func (s MasterUserOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MasterUserOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NodeToNodeEncryptionOptions struct { // True to enable node-to-node encryption. Enabled *bool `type:"boolean"` // contains filtered or unexported fields }
Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html).
func (s NodeToNodeEncryptionOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *NodeToNodeEncryptionOptions) SetEnabled(v bool) *NodeToNodeEncryptionOptions
SetEnabled sets the Enabled field's value.
func (s NodeToNodeEncryptionOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type NodeToNodeEncryptionOptionsStatus struct { // The node-to-node encryption options for the specified domain. // // Options is a required field Options *NodeToNodeEncryptionOptions `type:"structure" required:"true"` // The status of the node-to-node encryption options for the specified domain. // // Status is a required field Status *OptionStatus `type:"structure" required:"true"` // contains filtered or unexported fields }
Status of the node-to-node encryption options for the specified domain.
func (s NodeToNodeEncryptionOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *NodeToNodeEncryptionOptionsStatus) SetOptions(v *NodeToNodeEncryptionOptions) *NodeToNodeEncryptionOptionsStatus
SetOptions sets the Options field's value.
func (s *NodeToNodeEncryptionOptionsStatus) SetStatus(v *OptionStatus) *NodeToNodeEncryptionOptionsStatus
SetStatus sets the Status field's value.
func (s NodeToNodeEncryptionOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type OffPeakWindow struct { // A custom start time for the off-peak window, in Coordinated Universal Time // (UTC). The window length will always be 10 hours, so you can't specify an // end time. For example, if you specify 11:00 P.M. UTC as a start time, the // end time will automatically be set to 9:00 A.M. WindowStartTime *WindowStartTime `type:"structure"` // contains filtered or unexported fields }
A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.
If you don't specify a window start time, it defaults to 10:00 P.M. local time.
For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html).
func (s OffPeakWindow) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OffPeakWindow) SetWindowStartTime(v *WindowStartTime) *OffPeakWindow
SetWindowStartTime sets the WindowStartTime field's value.
func (s OffPeakWindow) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OffPeakWindow) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OffPeakWindowOptions struct { // Whether to enable an off-peak window. // // This option is only available when modifying a domain created prior to February // 16, 2023, not when creating a new domain. All domains created after this // date have the off-peak window enabled by default. You can't disable the off-peak // window after it's enabled for a domain. Enabled *bool `type:"boolean"` // Off-peak window settings for the domain. OffPeakWindow *OffPeakWindow `type:"structure"` // contains filtered or unexported fields }
Options for a domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html), during which OpenSearch Service can perform mandatory configuration changes on the domain.
func (s OffPeakWindowOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OffPeakWindowOptions) SetEnabled(v bool) *OffPeakWindowOptions
SetEnabled sets the Enabled field's value.
func (s *OffPeakWindowOptions) SetOffPeakWindow(v *OffPeakWindow) *OffPeakWindowOptions
SetOffPeakWindow sets the OffPeakWindow field's value.
func (s OffPeakWindowOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OffPeakWindowOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type OffPeakWindowOptionsStatus struct { // The domain's off-peak window configuration. Options *OffPeakWindowOptions `type:"structure"` // The current status of off-peak window options. Status *OptionStatus `type:"structure"` // contains filtered or unexported fields }
The status of off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) options for a domain.
func (s OffPeakWindowOptionsStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *OffPeakWindowOptionsStatus) SetOptions(v *OffPeakWindowOptions) *OffPeakWindowOptionsStatus
SetOptions sets the Options field's value.
func (s *OffPeakWindowOptionsStatus) SetStatus(v *OptionStatus) *OffPeakWindowOptionsStatus
SetStatus sets the Status field's value.
func (s OffPeakWindowOptionsStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type OpenSearchService struct { *client.Client }
OpenSearchService provides the API operation methods for making requests to Amazon OpenSearch Service. See this package's package overview docs for details on the service.
OpenSearchService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *OpenSearchService
New creates a new instance of the OpenSearchService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a OpenSearchService client from just a session. svc := opensearchservice.New(mySession) // Create a OpenSearchService client with additional configuration svc := opensearchservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *OpenSearchService) AcceptInboundConnection(input *AcceptInboundConnectionInput) (*AcceptInboundConnectionOutput, error)
AcceptInboundConnection API operation for Amazon OpenSearch Service.
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation AcceptInboundConnection for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection
func (c *OpenSearchService) AcceptInboundConnectionRequest(input *AcceptInboundConnectionInput) (req *request.Request, output *AcceptInboundConnectionOutput)
AcceptInboundConnectionRequest generates a "aws/request.Request" representing the client's request for the AcceptInboundConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AcceptInboundConnection for more information on using the AcceptInboundConnection API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AcceptInboundConnectionRequest method. req, resp := client.AcceptInboundConnectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection
func (c *OpenSearchService) AcceptInboundConnectionWithContext(ctx aws.Context, input *AcceptInboundConnectionInput, opts ...request.Option) (*AcceptInboundConnectionOutput, error)
AcceptInboundConnectionWithContext is the same as AcceptInboundConnection with the addition of the ability to pass a context and additional request options.
See AcceptInboundConnection for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) AddTags(input *AddTagsInput) (*AddTagsOutput, error)
AddTags API operation for Amazon OpenSearch Service.
Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation AddTags for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags
func (c *OpenSearchService) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)
AddTagsRequest generates a "aws/request.Request" representing the client's request for the AddTags operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AddTags for more information on using the AddTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AddTagsRequest method. req, resp := client.AddTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags
func (c *OpenSearchService) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)
AddTagsWithContext is the same as AddTags with the addition of the ability to pass a context and additional request options.
See AddTags for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) AssociatePackage(input *AssociatePackageInput) (*AssociatePackageOutput, error)
AssociatePackage API operation for Amazon OpenSearch Service.
Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation AssociatePackage for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage
func (c *OpenSearchService) AssociatePackageRequest(input *AssociatePackageInput) (req *request.Request, output *AssociatePackageOutput)
AssociatePackageRequest generates a "aws/request.Request" representing the client's request for the AssociatePackage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AssociatePackage for more information on using the AssociatePackage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AssociatePackageRequest method. req, resp := client.AssociatePackageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage
func (c *OpenSearchService) AssociatePackageWithContext(ctx aws.Context, input *AssociatePackageInput, opts ...request.Option) (*AssociatePackageOutput, error)
AssociatePackageWithContext is the same as AssociatePackage with the addition of the ability to pass a context and additional request options.
See AssociatePackage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) AuthorizeVpcEndpointAccess(input *AuthorizeVpcEndpointAccessInput) (*AuthorizeVpcEndpointAccessOutput, error)
AuthorizeVpcEndpointAccess API operation for Amazon OpenSearch Service.
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation AuthorizeVpcEndpointAccess for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
BaseException An error occurred while processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess
func (c *OpenSearchService) AuthorizeVpcEndpointAccessRequest(input *AuthorizeVpcEndpointAccessInput) (req *request.Request, output *AuthorizeVpcEndpointAccessOutput)
AuthorizeVpcEndpointAccessRequest generates a "aws/request.Request" representing the client's request for the AuthorizeVpcEndpointAccess operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AuthorizeVpcEndpointAccess for more information on using the AuthorizeVpcEndpointAccess API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AuthorizeVpcEndpointAccessRequest method. req, resp := client.AuthorizeVpcEndpointAccessRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess
func (c *OpenSearchService) AuthorizeVpcEndpointAccessWithContext(ctx aws.Context, input *AuthorizeVpcEndpointAccessInput, opts ...request.Option) (*AuthorizeVpcEndpointAccessOutput, error)
AuthorizeVpcEndpointAccessWithContext is the same as AuthorizeVpcEndpointAccess with the addition of the ability to pass a context and additional request options.
See AuthorizeVpcEndpointAccess for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) CancelServiceSoftwareUpdate(input *CancelServiceSoftwareUpdateInput) (*CancelServiceSoftwareUpdateOutput, error)
CancelServiceSoftwareUpdate API operation for Amazon OpenSearch Service.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation CancelServiceSoftwareUpdate for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate
func (c *OpenSearchService) CancelServiceSoftwareUpdateRequest(input *CancelServiceSoftwareUpdateInput) (req *request.Request, output *CancelServiceSoftwareUpdateOutput)
CancelServiceSoftwareUpdateRequest generates a "aws/request.Request" representing the client's request for the CancelServiceSoftwareUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelServiceSoftwareUpdate for more information on using the CancelServiceSoftwareUpdate API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelServiceSoftwareUpdateRequest method. req, resp := client.CancelServiceSoftwareUpdateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate
func (c *OpenSearchService) CancelServiceSoftwareUpdateWithContext(ctx aws.Context, input *CancelServiceSoftwareUpdateInput, opts ...request.Option) (*CancelServiceSoftwareUpdateOutput, error)
CancelServiceSoftwareUpdateWithContext is the same as CancelServiceSoftwareUpdate with the addition of the ability to pass a context and additional request options.
See CancelServiceSoftwareUpdate for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)
CreateDomain API operation for Amazon OpenSearch Service.
Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation CreateDomain for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
ResourceAlreadyExistsException An exception for creating a resource that already exists.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain
func (c *OpenSearchService) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)
CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDomain for more information on using the CreateDomain API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateDomainRequest method. req, resp := client.CreateDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain
func (c *OpenSearchService) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)
CreateDomainWithContext is the same as CreateDomain with the addition of the ability to pass a context and additional request options.
See CreateDomain for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) CreateOutboundConnection(input *CreateOutboundConnectionInput) (*CreateOutboundConnectionOutput, error)
CreateOutboundConnection API operation for Amazon OpenSearch Service.
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation CreateOutboundConnection for usage and error information.
Returned Error Types:
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceAlreadyExistsException An exception for creating a resource that already exists.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection
func (c *OpenSearchService) CreateOutboundConnectionRequest(input *CreateOutboundConnectionInput) (req *request.Request, output *CreateOutboundConnectionOutput)
CreateOutboundConnectionRequest generates a "aws/request.Request" representing the client's request for the CreateOutboundConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateOutboundConnection for more information on using the CreateOutboundConnection API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateOutboundConnectionRequest method. req, resp := client.CreateOutboundConnectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection
func (c *OpenSearchService) CreateOutboundConnectionWithContext(ctx aws.Context, input *CreateOutboundConnectionInput, opts ...request.Option) (*CreateOutboundConnectionOutput, error)
CreateOutboundConnectionWithContext is the same as CreateOutboundConnection with the addition of the ability to pass a context and additional request options.
See CreateOutboundConnection for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) CreatePackage(input *CreatePackageInput) (*CreatePackageOutput, error)
CreatePackage API operation for Amazon OpenSearch Service.
Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation CreatePackage for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
ResourceAlreadyExistsException An exception for creating a resource that already exists.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage
func (c *OpenSearchService) CreatePackageRequest(input *CreatePackageInput) (req *request.Request, output *CreatePackageOutput)
CreatePackageRequest generates a "aws/request.Request" representing the client's request for the CreatePackage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreatePackage for more information on using the CreatePackage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreatePackageRequest method. req, resp := client.CreatePackageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage
func (c *OpenSearchService) CreatePackageWithContext(ctx aws.Context, input *CreatePackageInput, opts ...request.Option) (*CreatePackageOutput, error)
CreatePackageWithContext is the same as CreatePackage with the addition of the ability to pass a context and additional request options.
See CreatePackage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) CreateVpcEndpoint(input *CreateVpcEndpointInput) (*CreateVpcEndpointOutput, error)
CreateVpcEndpoint API operation for Amazon OpenSearch Service.
Creates an Amazon OpenSearch Service-managed VPC endpoint.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation CreateVpcEndpoint for usage and error information.
Returned Error Types:
ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
BaseException An error occurred while processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpoint
func (c *OpenSearchService) CreateVpcEndpointRequest(input *CreateVpcEndpointInput) (req *request.Request, output *CreateVpcEndpointOutput)
CreateVpcEndpointRequest generates a "aws/request.Request" representing the client's request for the CreateVpcEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateVpcEndpoint for more information on using the CreateVpcEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateVpcEndpointRequest method. req, resp := client.CreateVpcEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpoint
func (c *OpenSearchService) CreateVpcEndpointWithContext(ctx aws.Context, input *CreateVpcEndpointInput, opts ...request.Option) (*CreateVpcEndpointOutput, error)
CreateVpcEndpointWithContext is the same as CreateVpcEndpoint with the addition of the ability to pass a context and additional request options.
See CreateVpcEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)
DeleteDomain API operation for Amazon OpenSearch Service.
Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DeleteDomain for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain
func (c *OpenSearchService) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)
DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDomain for more information on using the DeleteDomain API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteDomainRequest method. req, resp := client.DeleteDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain
func (c *OpenSearchService) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)
DeleteDomainWithContext is the same as DeleteDomain with the addition of the ability to pass a context and additional request options.
See DeleteDomain for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DeleteInboundConnection(input *DeleteInboundConnectionInput) (*DeleteInboundConnectionOutput, error)
DeleteInboundConnection API operation for Amazon OpenSearch Service.
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DeleteInboundConnection for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnection
func (c *OpenSearchService) DeleteInboundConnectionRequest(input *DeleteInboundConnectionInput) (req *request.Request, output *DeleteInboundConnectionOutput)
DeleteInboundConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteInboundConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteInboundConnection for more information on using the DeleteInboundConnection API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteInboundConnectionRequest method. req, resp := client.DeleteInboundConnectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnection
func (c *OpenSearchService) DeleteInboundConnectionWithContext(ctx aws.Context, input *DeleteInboundConnectionInput, opts ...request.Option) (*DeleteInboundConnectionOutput, error)
DeleteInboundConnectionWithContext is the same as DeleteInboundConnection with the addition of the ability to pass a context and additional request options.
See DeleteInboundConnection for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DeleteOutboundConnection(input *DeleteOutboundConnectionInput) (*DeleteOutboundConnectionOutput, error)
DeleteOutboundConnection API operation for Amazon OpenSearch Service.
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DeleteOutboundConnection for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnection
func (c *OpenSearchService) DeleteOutboundConnectionRequest(input *DeleteOutboundConnectionInput) (req *request.Request, output *DeleteOutboundConnectionOutput)
DeleteOutboundConnectionRequest generates a "aws/request.Request" representing the client's request for the DeleteOutboundConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteOutboundConnection for more information on using the DeleteOutboundConnection API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteOutboundConnectionRequest method. req, resp := client.DeleteOutboundConnectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnection
func (c *OpenSearchService) DeleteOutboundConnectionWithContext(ctx aws.Context, input *DeleteOutboundConnectionInput, opts ...request.Option) (*DeleteOutboundConnectionOutput, error)
DeleteOutboundConnectionWithContext is the same as DeleteOutboundConnection with the addition of the ability to pass a context and additional request options.
See DeleteOutboundConnection for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DeletePackage(input *DeletePackageInput) (*DeletePackageOutput, error)
DeletePackage API operation for Amazon OpenSearch Service.
Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DeletePackage for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage
func (c *OpenSearchService) DeletePackageRequest(input *DeletePackageInput) (req *request.Request, output *DeletePackageOutput)
DeletePackageRequest generates a "aws/request.Request" representing the client's request for the DeletePackage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeletePackage for more information on using the DeletePackage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeletePackageRequest method. req, resp := client.DeletePackageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage
func (c *OpenSearchService) DeletePackageWithContext(ctx aws.Context, input *DeletePackageInput, opts ...request.Option) (*DeletePackageOutput, error)
DeletePackageWithContext is the same as DeletePackage with the addition of the ability to pass a context and additional request options.
See DeletePackage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DeleteVpcEndpoint(input *DeleteVpcEndpointInput) (*DeleteVpcEndpointOutput, error)
DeleteVpcEndpoint API operation for Amazon OpenSearch Service.
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DeleteVpcEndpoint for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
BaseException An error occurred while processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteVpcEndpoint
func (c *OpenSearchService) DeleteVpcEndpointRequest(input *DeleteVpcEndpointInput) (req *request.Request, output *DeleteVpcEndpointOutput)
DeleteVpcEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteVpcEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteVpcEndpoint for more information on using the DeleteVpcEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteVpcEndpointRequest method. req, resp := client.DeleteVpcEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteVpcEndpoint
func (c *OpenSearchService) DeleteVpcEndpointWithContext(ctx aws.Context, input *DeleteVpcEndpointInput, opts ...request.Option) (*DeleteVpcEndpointOutput, error)
DeleteVpcEndpointWithContext is the same as DeleteVpcEndpoint with the addition of the ability to pass a context and additional request options.
See DeleteVpcEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error)
DescribeDomain API operation for Amazon OpenSearch Service.
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomain for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain
func (c *OpenSearchService) DescribeDomainAutoTunes(input *DescribeDomainAutoTunesInput) (*DescribeDomainAutoTunesOutput, error)
DescribeDomainAutoTunes API operation for Amazon OpenSearch Service.
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomainAutoTunes for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunes
func (c *OpenSearchService) DescribeDomainAutoTunesPages(input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool) error
DescribeDomainAutoTunesPages iterates over the pages of a DescribeDomainAutoTunes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeDomainAutoTunes method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeDomainAutoTunes operation. pageNum := 0 err := client.DescribeDomainAutoTunesPages(params, func(page *opensearchservice.DescribeDomainAutoTunesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribeDomainAutoTunesPagesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, fn func(*DescribeDomainAutoTunesOutput, bool) bool, opts ...request.Option) error
DescribeDomainAutoTunesPagesWithContext same as DescribeDomainAutoTunesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainAutoTunesRequest(input *DescribeDomainAutoTunesInput) (req *request.Request, output *DescribeDomainAutoTunesOutput)
DescribeDomainAutoTunesRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainAutoTunes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomainAutoTunes for more information on using the DescribeDomainAutoTunes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainAutoTunesRequest method. req, resp := client.DescribeDomainAutoTunesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunes
func (c *OpenSearchService) DescribeDomainAutoTunesWithContext(ctx aws.Context, input *DescribeDomainAutoTunesInput, opts ...request.Option) (*DescribeDomainAutoTunesOutput, error)
DescribeDomainAutoTunesWithContext is the same as DescribeDomainAutoTunes with the addition of the ability to pass a context and additional request options.
See DescribeDomainAutoTunes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainChangeProgress(input *DescribeDomainChangeProgressInput) (*DescribeDomainChangeProgressOutput, error)
DescribeDomainChangeProgress API operation for Amazon OpenSearch Service.
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomainChangeProgress for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainChangeProgress
func (c *OpenSearchService) DescribeDomainChangeProgressRequest(input *DescribeDomainChangeProgressInput) (req *request.Request, output *DescribeDomainChangeProgressOutput)
DescribeDomainChangeProgressRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainChangeProgress operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomainChangeProgress for more information on using the DescribeDomainChangeProgress API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainChangeProgressRequest method. req, resp := client.DescribeDomainChangeProgressRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainChangeProgress
func (c *OpenSearchService) DescribeDomainChangeProgressWithContext(ctx aws.Context, input *DescribeDomainChangeProgressInput, opts ...request.Option) (*DescribeDomainChangeProgressOutput, error)
DescribeDomainChangeProgressWithContext is the same as DescribeDomainChangeProgress with the addition of the ability to pass a context and additional request options.
See DescribeDomainChangeProgress for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainConfig(input *DescribeDomainConfigInput) (*DescribeDomainConfigOutput, error)
DescribeDomainConfig API operation for Amazon OpenSearch Service.
Returns the configuration of an Amazon OpenSearch Service domain.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomainConfig for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig
func (c *OpenSearchService) DescribeDomainConfigRequest(input *DescribeDomainConfigInput) (req *request.Request, output *DescribeDomainConfigOutput)
DescribeDomainConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomainConfig for more information on using the DescribeDomainConfig API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainConfigRequest method. req, resp := client.DescribeDomainConfigRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig
func (c *OpenSearchService) DescribeDomainConfigWithContext(ctx aws.Context, input *DescribeDomainConfigInput, opts ...request.Option) (*DescribeDomainConfigOutput, error)
DescribeDomainConfigWithContext is the same as DescribeDomainConfig with the addition of the ability to pass a context and additional request options.
See DescribeDomainConfig for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainHealth(input *DescribeDomainHealthInput) (*DescribeDomainHealthOutput, error)
DescribeDomainHealth API operation for Amazon OpenSearch Service.
Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomainHealth for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealth
func (c *OpenSearchService) DescribeDomainHealthRequest(input *DescribeDomainHealthInput) (req *request.Request, output *DescribeDomainHealthOutput)
DescribeDomainHealthRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainHealth operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomainHealth for more information on using the DescribeDomainHealth API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainHealthRequest method. req, resp := client.DescribeDomainHealthRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealth
func (c *OpenSearchService) DescribeDomainHealthWithContext(ctx aws.Context, input *DescribeDomainHealthInput, opts ...request.Option) (*DescribeDomainHealthOutput, error)
DescribeDomainHealthWithContext is the same as DescribeDomainHealth with the addition of the ability to pass a context and additional request options.
See DescribeDomainHealth for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainNodes(input *DescribeDomainNodesInput) (*DescribeDomainNodesOutput, error)
DescribeDomainNodes API operation for Amazon OpenSearch Service.
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomainNodes for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
DependencyFailureException An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainNodes
func (c *OpenSearchService) DescribeDomainNodesRequest(input *DescribeDomainNodesInput) (req *request.Request, output *DescribeDomainNodesOutput)
DescribeDomainNodesRequest generates a "aws/request.Request" representing the client's request for the DescribeDomainNodes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomainNodes for more information on using the DescribeDomainNodes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainNodesRequest method. req, resp := client.DescribeDomainNodesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainNodes
func (c *OpenSearchService) DescribeDomainNodesWithContext(ctx aws.Context, input *DescribeDomainNodesInput, opts ...request.Option) (*DescribeDomainNodesOutput, error)
DescribeDomainNodesWithContext is the same as DescribeDomainNodes with the addition of the ability to pass a context and additional request options.
See DescribeDomainNodes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput)
DescribeDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomain for more information on using the DescribeDomain API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainRequest method. req, resp := client.DescribeDomainRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain
func (c *OpenSearchService) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error)
DescribeDomainWithContext is the same as DescribeDomain with the addition of the ability to pass a context and additional request options.
See DescribeDomain for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDomains(input *DescribeDomainsInput) (*DescribeDomainsOutput, error)
DescribeDomains API operation for Amazon OpenSearch Service.
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDomains for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains
func (c *OpenSearchService) DescribeDomainsRequest(input *DescribeDomainsInput) (req *request.Request, output *DescribeDomainsOutput)
DescribeDomainsRequest generates a "aws/request.Request" representing the client's request for the DescribeDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDomains for more information on using the DescribeDomains API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDomainsRequest method. req, resp := client.DescribeDomainsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains
func (c *OpenSearchService) DescribeDomainsWithContext(ctx aws.Context, input *DescribeDomainsInput, opts ...request.Option) (*DescribeDomainsOutput, error)
DescribeDomainsWithContext is the same as DescribeDomains with the addition of the ability to pass a context and additional request options.
See DescribeDomains for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeDryRunProgress(input *DescribeDryRunProgressInput) (*DescribeDryRunProgressOutput, error)
DescribeDryRunProgress API operation for Amazon OpenSearch Service.
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeDryRunProgress for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDryRunProgress
func (c *OpenSearchService) DescribeDryRunProgressRequest(input *DescribeDryRunProgressInput) (req *request.Request, output *DescribeDryRunProgressOutput)
DescribeDryRunProgressRequest generates a "aws/request.Request" representing the client's request for the DescribeDryRunProgress operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDryRunProgress for more information on using the DescribeDryRunProgress API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDryRunProgressRequest method. req, resp := client.DescribeDryRunProgressRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDryRunProgress
func (c *OpenSearchService) DescribeDryRunProgressWithContext(ctx aws.Context, input *DescribeDryRunProgressInput, opts ...request.Option) (*DescribeDryRunProgressOutput, error)
DescribeDryRunProgressWithContext is the same as DescribeDryRunProgress with the addition of the ability to pass a context and additional request options.
See DescribeDryRunProgress for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeInboundConnections(input *DescribeInboundConnectionsInput) (*DescribeInboundConnectionsOutput, error)
DescribeInboundConnections API operation for Amazon OpenSearch Service.
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeInboundConnections for usage and error information.
Returned Error Types:
InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnections
func (c *OpenSearchService) DescribeInboundConnectionsPages(input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool) error
DescribeInboundConnectionsPages iterates over the pages of a DescribeInboundConnections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeInboundConnections method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeInboundConnections operation. pageNum := 0 err := client.DescribeInboundConnectionsPages(params, func(page *opensearchservice.DescribeInboundConnectionsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribeInboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, fn func(*DescribeInboundConnectionsOutput, bool) bool, opts ...request.Option) error
DescribeInboundConnectionsPagesWithContext same as DescribeInboundConnectionsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeInboundConnectionsRequest(input *DescribeInboundConnectionsInput) (req *request.Request, output *DescribeInboundConnectionsOutput)
DescribeInboundConnectionsRequest generates a "aws/request.Request" representing the client's request for the DescribeInboundConnections operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeInboundConnections for more information on using the DescribeInboundConnections API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeInboundConnectionsRequest method. req, resp := client.DescribeInboundConnectionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnections
func (c *OpenSearchService) DescribeInboundConnectionsWithContext(ctx aws.Context, input *DescribeInboundConnectionsInput, opts ...request.Option) (*DescribeInboundConnectionsOutput, error)
DescribeInboundConnectionsWithContext is the same as DescribeInboundConnections with the addition of the ability to pass a context and additional request options.
See DescribeInboundConnections for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeInstanceTypeLimits(input *DescribeInstanceTypeLimitsInput) (*DescribeInstanceTypeLimitsOutput, error)
DescribeInstanceTypeLimits API operation for Amazon OpenSearch Service.
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeInstanceTypeLimits for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
InvalidTypeException An exception for trying to create or access a sub-resource that's either invalid or not supported.
LimitExceededException An exception for trying to create more than the allowed number of resources or sub-resources.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimits
func (c *OpenSearchService) DescribeInstanceTypeLimitsRequest(input *DescribeInstanceTypeLimitsInput) (req *request.Request, output *DescribeInstanceTypeLimitsOutput)
DescribeInstanceTypeLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeInstanceTypeLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeInstanceTypeLimits for more information on using the DescribeInstanceTypeLimits API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeInstanceTypeLimitsRequest method. req, resp := client.DescribeInstanceTypeLimitsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimits
func (c *OpenSearchService) DescribeInstanceTypeLimitsWithContext(ctx aws.Context, input *DescribeInstanceTypeLimitsInput, opts ...request.Option) (*DescribeInstanceTypeLimitsOutput, error)
DescribeInstanceTypeLimitsWithContext is the same as DescribeInstanceTypeLimits with the addition of the ability to pass a context and additional request options.
See DescribeInstanceTypeLimits for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeOutboundConnections(input *DescribeOutboundConnectionsInput) (*DescribeOutboundConnectionsOutput, error)
DescribeOutboundConnections API operation for Amazon OpenSearch Service.
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeOutboundConnections for usage and error information.
Returned Error Types:
InvalidPaginationTokenException Request processing failed because you provided an invalid pagination token.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections
func (c *OpenSearchService) DescribeOutboundConnectionsPages(input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool) error
DescribeOutboundConnectionsPages iterates over the pages of a DescribeOutboundConnections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeOutboundConnections method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeOutboundConnections operation. pageNum := 0 err := client.DescribeOutboundConnectionsPages(params, func(page *opensearchservice.DescribeOutboundConnectionsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribeOutboundConnectionsPagesWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, fn func(*DescribeOutboundConnectionsOutput, bool) bool, opts ...request.Option) error
DescribeOutboundConnectionsPagesWithContext same as DescribeOutboundConnectionsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeOutboundConnectionsRequest(input *DescribeOutboundConnectionsInput) (req *request.Request, output *DescribeOutboundConnectionsOutput)
DescribeOutboundConnectionsRequest generates a "aws/request.Request" representing the client's request for the DescribeOutboundConnections operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeOutboundConnections for more information on using the DescribeOutboundConnections API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeOutboundConnectionsRequest method. req, resp := client.DescribeOutboundConnectionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections
func (c *OpenSearchService) DescribeOutboundConnectionsWithContext(ctx aws.Context, input *DescribeOutboundConnectionsInput, opts ...request.Option) (*DescribeOutboundConnectionsOutput, error)
DescribeOutboundConnectionsWithContext is the same as DescribeOutboundConnections with the addition of the ability to pass a context and additional request options.
See DescribeOutboundConnections for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribePackages(input *DescribePackagesInput) (*DescribePackagesOutput, error)
DescribePackages API operation for Amazon OpenSearch Service.
Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribePackages for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages
func (c *OpenSearchService) DescribePackagesPages(input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool) error
DescribePackagesPages iterates over the pages of a DescribePackages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribePackages method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribePackages operation. pageNum := 0 err := client.DescribePackagesPages(params, func(page *opensearchservice.DescribePackagesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribePackagesPagesWithContext(ctx aws.Context, input *DescribePackagesInput, fn func(*DescribePackagesOutput, bool) bool, opts ...request.Option) error
DescribePackagesPagesWithContext same as DescribePackagesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribePackagesRequest(input *DescribePackagesInput) (req *request.Request, output *DescribePackagesOutput)
DescribePackagesRequest generates a "aws/request.Request" representing the client's request for the DescribePackages operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribePackages for more information on using the DescribePackages API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribePackagesRequest method. req, resp := client.DescribePackagesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages
func (c *OpenSearchService) DescribePackagesWithContext(ctx aws.Context, input *DescribePackagesInput, opts ...request.Option) (*DescribePackagesOutput, error)
DescribePackagesWithContext is the same as DescribePackages with the addition of the ability to pass a context and additional request options.
See DescribePackages for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeReservedInstanceOfferings(input *DescribeReservedInstanceOfferingsInput) (*DescribeReservedInstanceOfferingsOutput, error)
DescribeReservedInstanceOfferings API operation for Amazon OpenSearch Service.
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeReservedInstanceOfferings for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings
func (c *OpenSearchService) DescribeReservedInstanceOfferingsPages(input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool) error
DescribeReservedInstanceOfferingsPages iterates over the pages of a DescribeReservedInstanceOfferings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeReservedInstanceOfferings method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeReservedInstanceOfferings operation. pageNum := 0 err := client.DescribeReservedInstanceOfferingsPages(params, func(page *opensearchservice.DescribeReservedInstanceOfferingsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribeReservedInstanceOfferingsPagesWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, fn func(*DescribeReservedInstanceOfferingsOutput, bool) bool, opts ...request.Option) error
DescribeReservedInstanceOfferingsPagesWithContext same as DescribeReservedInstanceOfferingsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeReservedInstanceOfferingsRequest(input *DescribeReservedInstanceOfferingsInput) (req *request.Request, output *DescribeReservedInstanceOfferingsOutput)
DescribeReservedInstanceOfferingsRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedInstanceOfferings operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeReservedInstanceOfferings for more information on using the DescribeReservedInstanceOfferings API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeReservedInstanceOfferingsRequest method. req, resp := client.DescribeReservedInstanceOfferingsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings
func (c *OpenSearchService) DescribeReservedInstanceOfferingsWithContext(ctx aws.Context, input *DescribeReservedInstanceOfferingsInput, opts ...request.Option) (*DescribeReservedInstanceOfferingsOutput, error)
DescribeReservedInstanceOfferingsWithContext is the same as DescribeReservedInstanceOfferings with the addition of the ability to pass a context and additional request options.
See DescribeReservedInstanceOfferings for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeReservedInstances(input *DescribeReservedInstancesInput) (*DescribeReservedInstancesOutput, error)
DescribeReservedInstances API operation for Amazon OpenSearch Service.
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeReservedInstances for usage and error information.
Returned Error Types:
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstances
func (c *OpenSearchService) DescribeReservedInstancesPages(input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool) error
DescribeReservedInstancesPages iterates over the pages of a DescribeReservedInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeReservedInstances method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeReservedInstances operation. pageNum := 0 err := client.DescribeReservedInstancesPages(params, func(page *opensearchservice.DescribeReservedInstancesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) DescribeReservedInstancesPagesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, fn func(*DescribeReservedInstancesOutput, bool) bool, opts ...request.Option) error
DescribeReservedInstancesPagesWithContext same as DescribeReservedInstancesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeReservedInstancesRequest(input *DescribeReservedInstancesInput) (req *request.Request, output *DescribeReservedInstancesOutput)
DescribeReservedInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeReservedInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeReservedInstances for more information on using the DescribeReservedInstances API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeReservedInstancesRequest method. req, resp := client.DescribeReservedInstancesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstances
func (c *OpenSearchService) DescribeReservedInstancesWithContext(ctx aws.Context, input *DescribeReservedInstancesInput, opts ...request.Option) (*DescribeReservedInstancesOutput, error)
DescribeReservedInstancesWithContext is the same as DescribeReservedInstances with the addition of the ability to pass a context and additional request options.
See DescribeReservedInstances for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DescribeVpcEndpoints(input *DescribeVpcEndpointsInput) (*DescribeVpcEndpointsOutput, error)
DescribeVpcEndpoints API operation for Amazon OpenSearch Service.
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DescribeVpcEndpoints for usage and error information.
Returned Error Types:
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
BaseException An error occurred while processing the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeVpcEndpoints
func (c *OpenSearchService) DescribeVpcEndpointsRequest(input *DescribeVpcEndpointsInput) (req *request.Request, output *DescribeVpcEndpointsOutput)
DescribeVpcEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeVpcEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeVpcEndpoints for more information on using the DescribeVpcEndpoints API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeVpcEndpointsRequest method. req, resp := client.DescribeVpcEndpointsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeVpcEndpoints
func (c *OpenSearchService) DescribeVpcEndpointsWithContext(ctx aws.Context, input *DescribeVpcEndpointsInput, opts ...request.Option) (*DescribeVpcEndpointsOutput, error)
DescribeVpcEndpointsWithContext is the same as DescribeVpcEndpoints with the addition of the ability to pass a context and additional request options.
See DescribeVpcEndpoints for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) DissociatePackage(input *DissociatePackageInput) (*DissociatePackageOutput, error)
DissociatePackage API operation for Amazon OpenSearch Service.
Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation DissociatePackage for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
ConflictException An error occurred because the client attempts to remove a resource that is currently in use.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage
func (c *OpenSearchService) DissociatePackageRequest(input *DissociatePackageInput) (req *request.Request, output *DissociatePackageOutput)
DissociatePackageRequest generates a "aws/request.Request" representing the client's request for the DissociatePackage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DissociatePackage for more information on using the DissociatePackage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DissociatePackageRequest method. req, resp := client.DissociatePackageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage
func (c *OpenSearchService) DissociatePackageWithContext(ctx aws.Context, input *DissociatePackageInput, opts ...request.Option) (*DissociatePackageOutput, error)
DissociatePackageWithContext is the same as DissociatePackage with the addition of the ability to pass a context and additional request options.
See DissociatePackage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetCompatibleVersions(input *GetCompatibleVersionsInput) (*GetCompatibleVersionsOutput, error)
GetCompatibleVersions API operation for Amazon OpenSearch Service.
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation GetCompatibleVersions for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersions
func (c *OpenSearchService) GetCompatibleVersionsRequest(input *GetCompatibleVersionsInput) (req *request.Request, output *GetCompatibleVersionsOutput)
GetCompatibleVersionsRequest generates a "aws/request.Request" representing the client's request for the GetCompatibleVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetCompatibleVersions for more information on using the GetCompatibleVersions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetCompatibleVersionsRequest method. req, resp := client.GetCompatibleVersionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersions
func (c *OpenSearchService) GetCompatibleVersionsWithContext(ctx aws.Context, input *GetCompatibleVersionsInput, opts ...request.Option) (*GetCompatibleVersionsOutput, error)
GetCompatibleVersionsWithContext is the same as GetCompatibleVersions with the addition of the ability to pass a context and additional request options.
See GetCompatibleVersions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetPackageVersionHistory(input *GetPackageVersionHistoryInput) (*GetPackageVersionHistoryOutput, error)
GetPackageVersionHistory API operation for Amazon OpenSearch Service.
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation GetPackageVersionHistory for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory
func (c *OpenSearchService) GetPackageVersionHistoryPages(input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool) error
GetPackageVersionHistoryPages iterates over the pages of a GetPackageVersionHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See GetPackageVersionHistory method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a GetPackageVersionHistory operation. pageNum := 0 err := client.GetPackageVersionHistoryPages(params, func(page *opensearchservice.GetPackageVersionHistoryOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) GetPackageVersionHistoryPagesWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, fn func(*GetPackageVersionHistoryOutput, bool) bool, opts ...request.Option) error
GetPackageVersionHistoryPagesWithContext same as GetPackageVersionHistoryPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetPackageVersionHistoryRequest(input *GetPackageVersionHistoryInput) (req *request.Request, output *GetPackageVersionHistoryOutput)
GetPackageVersionHistoryRequest generates a "aws/request.Request" representing the client's request for the GetPackageVersionHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetPackageVersionHistory for more information on using the GetPackageVersionHistory API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetPackageVersionHistoryRequest method. req, resp := client.GetPackageVersionHistoryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory
func (c *OpenSearchService) GetPackageVersionHistoryWithContext(ctx aws.Context, input *GetPackageVersionHistoryInput, opts ...request.Option) (*GetPackageVersionHistoryOutput, error)
GetPackageVersionHistoryWithContext is the same as GetPackageVersionHistory with the addition of the ability to pass a context and additional request options.
See GetPackageVersionHistory for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetUpgradeHistory(input *GetUpgradeHistoryInput) (*GetUpgradeHistoryOutput, error)
GetUpgradeHistory API operation for Amazon OpenSearch Service.
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation GetUpgradeHistory for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistory
func (c *OpenSearchService) GetUpgradeHistoryPages(input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool) error
GetUpgradeHistoryPages iterates over the pages of a GetUpgradeHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See GetUpgradeHistory method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a GetUpgradeHistory operation. pageNum := 0 err := client.GetUpgradeHistoryPages(params, func(page *opensearchservice.GetUpgradeHistoryOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) GetUpgradeHistoryPagesWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, fn func(*GetUpgradeHistoryOutput, bool) bool, opts ...request.Option) error
GetUpgradeHistoryPagesWithContext same as GetUpgradeHistoryPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetUpgradeHistoryRequest(input *GetUpgradeHistoryInput) (req *request.Request, output *GetUpgradeHistoryOutput)
GetUpgradeHistoryRequest generates a "aws/request.Request" representing the client's request for the GetUpgradeHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUpgradeHistory for more information on using the GetUpgradeHistory API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetUpgradeHistoryRequest method. req, resp := client.GetUpgradeHistoryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistory
func (c *OpenSearchService) GetUpgradeHistoryWithContext(ctx aws.Context, input *GetUpgradeHistoryInput, opts ...request.Option) (*GetUpgradeHistoryOutput, error)
GetUpgradeHistoryWithContext is the same as GetUpgradeHistory with the addition of the ability to pass a context and additional request options.
See GetUpgradeHistory for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) GetUpgradeStatus(input *GetUpgradeStatusInput) (*GetUpgradeStatusOutput, error)
GetUpgradeStatus API operation for Amazon OpenSearch Service.
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation GetUpgradeStatus for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
DisabledOperationException An error occured because the client wanted to access an unsupported operation.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatus
func (c *OpenSearchService) GetUpgradeStatusRequest(input *GetUpgradeStatusInput) (req *request.Request, output *GetUpgradeStatusOutput)
GetUpgradeStatusRequest generates a "aws/request.Request" representing the client's request for the GetUpgradeStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUpgradeStatus for more information on using the GetUpgradeStatus API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetUpgradeStatusRequest method. req, resp := client.GetUpgradeStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatus
func (c *OpenSearchService) GetUpgradeStatusWithContext(ctx aws.Context, input *GetUpgradeStatusInput, opts ...request.Option) (*GetUpgradeStatusOutput, error)
GetUpgradeStatusWithContext is the same as GetUpgradeStatus with the addition of the ability to pass a context and additional request options.
See GetUpgradeStatus for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListDomainNames(input *ListDomainNamesInput) (*ListDomainNamesOutput, error)
ListDomainNames API operation for Amazon OpenSearch Service.
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation ListDomainNames for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames
func (c *OpenSearchService) ListDomainNamesRequest(input *ListDomainNamesInput) (req *request.Request, output *ListDomainNamesOutput)
ListDomainNamesRequest generates a "aws/request.Request" representing the client's request for the ListDomainNames operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDomainNames for more information on using the ListDomainNames API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDomainNamesRequest method. req, resp := client.ListDomainNamesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames
func (c *OpenSearchService) ListDomainNamesWithContext(ctx aws.Context, input *ListDomainNamesInput, opts ...request.Option) (*ListDomainNamesOutput, error)
ListDomainNamesWithContext is the same as ListDomainNames with the addition of the ability to pass a context and additional request options.
See ListDomainNames for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListDomainsForPackage(input *ListDomainsForPackageInput) (*ListDomainsForPackageOutput, error)
ListDomainsForPackage API operation for Amazon OpenSearch Service.
Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation ListDomainsForPackage for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage
func (c *OpenSearchService) ListDomainsForPackagePages(input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool) error
ListDomainsForPackagePages iterates over the pages of a ListDomainsForPackage operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDomainsForPackage method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDomainsForPackage operation. pageNum := 0 err := client.ListDomainsForPackagePages(params, func(page *opensearchservice.ListDomainsForPackageOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) ListDomainsForPackagePagesWithContext(ctx aws.Context, input *ListDomainsForPackageInput, fn func(*ListDomainsForPackageOutput, bool) bool, opts ...request.Option) error
ListDomainsForPackagePagesWithContext same as ListDomainsForPackagePages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListDomainsForPackageRequest(input *ListDomainsForPackageInput) (req *request.Request, output *ListDomainsForPackageOutput)
ListDomainsForPackageRequest generates a "aws/request.Request" representing the client's request for the ListDomainsForPackage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDomainsForPackage for more information on using the ListDomainsForPackage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDomainsForPackageRequest method. req, resp := client.ListDomainsForPackageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage
func (c *OpenSearchService) ListDomainsForPackageWithContext(ctx aws.Context, input *ListDomainsForPackageInput, opts ...request.Option) (*ListDomainsForPackageOutput, error)
ListDomainsForPackageWithContext is the same as ListDomainsForPackage with the addition of the ability to pass a context and additional request options.
See ListDomainsForPackage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListInstanceTypeDetails(input *ListInstanceTypeDetailsInput) (*ListInstanceTypeDetailsOutput, error)
ListInstanceTypeDetails API operation for Amazon OpenSearch Service.
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation ListInstanceTypeDetails for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails
func (c *OpenSearchService) ListInstanceTypeDetailsPages(input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool) error
ListInstanceTypeDetailsPages iterates over the pages of a ListInstanceTypeDetails operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListInstanceTypeDetails method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListInstanceTypeDetails operation. pageNum := 0 err := client.ListInstanceTypeDetailsPages(params, func(page *opensearchservice.ListInstanceTypeDetailsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *OpenSearchService) ListInstanceTypeDetailsPagesWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, fn func(*ListInstanceTypeDetailsOutput, bool) bool, opts ...request.Option) error
ListInstanceTypeDetailsPagesWithContext same as ListInstanceTypeDetailsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListInstanceTypeDetailsRequest(input *ListInstanceTypeDetailsInput) (req *request.Request, output *ListInstanceTypeDetailsOutput)
ListInstanceTypeDetailsRequest generates a "aws/request.Request" representing the client's request for the ListInstanceTypeDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListInstanceTypeDetails for more information on using the ListInstanceTypeDetails API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListInstanceTypeDetailsRequest method. req, resp := client.ListInstanceTypeDetailsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails
func (c *OpenSearchService) ListInstanceTypeDetailsWithContext(ctx aws.Context, input *ListInstanceTypeDetailsInput, opts ...request.Option) (*ListInstanceTypeDetailsOutput, error)
ListInstanceTypeDetailsWithContext is the same as ListInstanceTypeDetails with the addition of the ability to pass a context and additional request options.
See ListInstanceTypeDetails for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *OpenSearchService) ListPackagesForDomain(input *ListPackagesForDomainInput) (*ListPackagesForDomainOutput, error)
ListPackagesForDomain API operation for Amazon OpenSearch Service.
Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon OpenSearch Service's API operation ListPackagesForDomain for usage and error information.
Returned Error Types:
BaseException An error occurred while processing the request.
InternalException Request processing failed because of an unknown error, exception, or internal failure.
ResourceNotFoundException An exception for accessing or deleting a resource that doesn't exist.
AccessDeniedException An error occurred because you don't have permissions to access the resource.
ValidationException An exception for accessing or deleting a resource that doesn't exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomain
func (c *OpenSearchService) ListPackagesForDomainPages(input *ListPackagesForDomainInput, fn func(*ListPackagesForDomainOutput, bool) bool) error
ListPackagesForDomainPages iterates over the pages of a ListPackagesForDomain operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPackagesForDomain method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListPackagesForDomain operation. pageNum := 0 err := client.ListPackagesForDomainPages(params, func(page *opensearchservice.ListPackagesForDomainOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })