Documentation ¶
Index ¶
- type AccessDeniedException
- type ConflictException
- type ConflictExceptionReason
- type EdgeStructure
- type ExplainMode
- type Format
- type GraphDataSummary
- type GraphSnapshotSummary
- type GraphStatus
- type GraphSummary
- type GraphSummaryMode
- type ImportOptions
- type ImportOptionsMemberNeptune
- type ImportTaskDetails
- type ImportTaskStatus
- type ImportTaskSummary
- type InternalServerException
- type NeptuneImportOptions
- type NodeStructure
- type PlanCacheType
- type PrivateGraphEndpointStatus
- type PrivateGraphEndpointSummary
- type QueryLanguage
- type QueryState
- type QueryStateInput
- type QuerySummary
- type ResourceNotFoundException
- type ServiceQuotaExceededException
- type SnapshotStatus
- type ThrottlingException
- type UnknownUnionMember
- type UnprocessableException
- type UnprocessableExceptionReason
- type ValidationException
- type ValidationExceptionReason
- type VectorSearchConfiguration
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
Raised in case of an authentication or authorization failure.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string Reason ConflictExceptionReason // contains filtered or unexported fields }
Raised when a conflict is encountered.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ConflictExceptionReason ¶
type ConflictExceptionReason string
const (
ConflictExceptionReasonConcurrentModification ConflictExceptionReason = "CONCURRENT_MODIFICATION"
)
Enum values for ConflictExceptionReason
func (ConflictExceptionReason) Values ¶
func (ConflictExceptionReason) Values() []ConflictExceptionReason
Values returns all known values for ConflictExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type EdgeStructure ¶
type EdgeStructure struct { // The number of instances of the edge in the graph. Count *int64 // A list of the properties associated with the edge. EdgeProperties []string // contains filtered or unexported fields }
Contains information about an edge in a Neptune Analytics graph.
type ExplainMode ¶
type ExplainMode string
const ( ExplainModeStatic ExplainMode = "STATIC" ExplainModeDetails ExplainMode = "DETAILS" )
Enum values for ExplainMode
func (ExplainMode) Values ¶
func (ExplainMode) Values() []ExplainMode
Values returns all known values for ExplainMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type GraphDataSummary ¶
type GraphDataSummary struct { // A list of the edge labels in the graph. EdgeLabels []string // A list of the distinct edge properties in the graph, along with the count of // edges where each property is used. EdgeProperties []map[string]int64 // This field is only present when the requested mode is DETAILED. It contains a // list of edge structures. EdgeStructures []EdgeStructure // A list of distinct node labels in the graph. NodeLabels []string // A list of the distinct node properties in the graph, along with the count of // nodes where each property is used. NodeProperties []map[string]int64 // This field is only present when the requested mode is DETAILED. It contains a // list of node structures. NodeStructures []NodeStructure // The number of unique edge labels in the graph. NumEdgeLabels *int64 // The number of edge properties in the graph. NumEdgeProperties *int64 // The number of edges in the graph. NumEdges *int64 // The number of distinct node labels in the graph. NumNodeLabels *int64 // The number of distinct node properties in the graph. NumNodeProperties *int64 // The number of nodes in the graph. NumNodes *int64 // The total number of usages of all edge properties. TotalEdgePropertyValues *int64 // The total number of usages of all node properties. TotalNodePropertyValues *int64 // contains filtered or unexported fields }
Summary information about the graph.
type GraphSnapshotSummary ¶
type GraphSnapshotSummary struct { // The ARN of the graph snapshot. // // This member is required. Arn *string // The unique identifier of the graph snapshot. // // This member is required. Id *string // The snapshot name. For example: my-snapshot-1 . // // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first // character must be a letter. It cannot end with a hyphen or contain two // consecutive hyphens. // // This member is required. Name *string // The ID of the KMS key used to encrypt and decrypt the snapshot. KmsKeyIdentifier *string // The time when the snapshot was created. SnapshotCreateTime *time.Time // The graph identifier for the graph for which a snapshot is to be created. SourceGraphId *string // The status of the graph snapshot. Status SnapshotStatus // contains filtered or unexported fields }
Details about a graph snapshot.
type GraphStatus ¶
type GraphStatus string
const ( GraphStatusCreating GraphStatus = "CREATING" GraphStatusAvailable GraphStatus = "AVAILABLE" GraphStatusDeleting GraphStatus = "DELETING" GraphStatusResetting GraphStatus = "RESETTING" GraphStatusUpdating GraphStatus = "UPDATING" GraphStatusSnapshotting GraphStatus = "SNAPSHOTTING" GraphStatusFailed GraphStatus = "FAILED" GraphStatusImporting GraphStatus = "IMPORTING" )
Enum values for GraphStatus
func (GraphStatus) Values ¶
func (GraphStatus) Values() []GraphStatus
Values returns all known values for GraphStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type GraphSummary ¶
type GraphSummary struct { // The ARN associated with the graph. // // This member is required. Arn *string // The unique identifier of the graph. // // This member is required. Id *string // The name of the graph. // // This member is required. Name *string // If true , deletion protection is enabled for the graph. DeletionProtection *bool // The graph endpoint. Endpoint *string // The ID of the KMS key used to encrypt and decrypt graph data. KmsKeyIdentifier *string // The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the // graph. ProvisionedMemory *int32 // If true , the graph has a public endpoint, otherwise not. PublicConnectivity *bool // The number of replicas for the graph. ReplicaCount *int32 // The status of the graph. Status GraphStatus // contains filtered or unexported fields }
Summary details about a graph.
type GraphSummaryMode ¶
type GraphSummaryMode string
const ( GraphSummaryModeBasic GraphSummaryMode = "BASIC" GraphSummaryModeDetailed GraphSummaryMode = "DETAILED" )
Enum values for GraphSummaryMode
func (GraphSummaryMode) Values ¶
func (GraphSummaryMode) Values() []GraphSummaryMode
Values returns all known values for GraphSummaryMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ImportOptions ¶
type ImportOptions interface {
// contains filtered or unexported methods
}
Options for how to perform an import.
The following types satisfy this interface:
ImportOptionsMemberNeptune
Example (OutputUsage) ¶
// Code generated by smithy-go-codegen DO NOT EDIT. package main import ( "e.coding.net/g-nnjn4981/aito/aws-sdk-go-v2/service/neptunegraph/types" "fmt" ) func main() { var union types.ImportOptions // type switches can be used to check the union value switch v := union.(type) { case *types.ImportOptionsMemberNeptune: _ = v.Value // Value is types.NeptuneImportOptions case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } } var _ *types.NeptuneImportOptions
Output:
type ImportOptionsMemberNeptune ¶
type ImportOptionsMemberNeptune struct { Value NeptuneImportOptions // contains filtered or unexported fields }
Options for importing data from a Neptune database.
type ImportTaskDetails ¶
type ImportTaskDetails struct { // The number of dictionary entries in the import task. // // This member is required. DictionaryEntryCount *int64 // The number of errors encountered so far. // // This member is required. ErrorCount *int32 // The percentage progress so far. // // This member is required. ProgressPercentage *int32 // Time at which the import task started. // // This member is required. StartTime *time.Time // The number of statements in the import task. // // This member is required. StatementCount *int64 // Status of the import task. // // This member is required. Status *string // Seconds elapsed since the import task started. // // This member is required. TimeElapsedSeconds *int64 // Details about the errors that have been encountered. ErrorDetails *string // contains filtered or unexported fields }
Contains details about an import task.
type ImportTaskStatus ¶
type ImportTaskStatus string
const ( ImportTaskStatusInitializing ImportTaskStatus = "INITIALIZING" ImportTaskStatusExporting ImportTaskStatus = "EXPORTING" ImportTaskStatusAnalyzingData ImportTaskStatus = "ANALYZING_DATA" ImportTaskStatusImporting ImportTaskStatus = "IMPORTING" ImportTaskStatusReprovisioning ImportTaskStatus = "REPROVISIONING" ImportTaskStatusRollingBack ImportTaskStatus = "ROLLING_BACK" ImportTaskStatusSucceeded ImportTaskStatus = "SUCCEEDED" ImportTaskStatusFailed ImportTaskStatus = "FAILED" ImportTaskStatusCancelling ImportTaskStatus = "CANCELLING" ImportTaskStatusCancelled ImportTaskStatus = "CANCELLED" )
Enum values for ImportTaskStatus
func (ImportTaskStatus) Values ¶
func (ImportTaskStatus) Values() []ImportTaskStatus
Values returns all known values for ImportTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ImportTaskSummary ¶
type ImportTaskSummary struct { // The ARN of the IAM role that will allow access to the data that is to be // imported. // // This member is required. RoleArn *string // A URL identifying to the location of the data to be imported. This can be an // Amazon S3 path, or can point to a Neptune database endpoint or snapshot // // This member is required. Source *string // Status of the import task. // // This member is required. Status ImportTaskStatus // The unique identifier of the import task. // // This member is required. TaskId *string // Specifies the format of S3 data to be imported. Valid values are CSV , which // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. // // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format Format // The unique identifier of the Neptune Analytics graph. GraphId *string // contains filtered or unexported fields }
Details about an import task.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
A failure occurred on the server.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type NeptuneImportOptions ¶
type NeptuneImportOptions struct { // The KMS key to use to encrypt data in the S3 bucket where the graph data is // exported // // This member is required. S3ExportKmsKeyId *string // The path to an S3 bucket from which to import data. // // This member is required. S3ExportPath *string // Neptune Analytics supports label-less vertices and no labels are assigned // unless one is explicitly provided. Neptune assigns default labels when none is // explicitly provided. When importing the data into Neptune Analytics, the default // vertex labels can be omitted by setting preserveDefaultVertexLabels to false. // Note that if the vertex only has default labels, and has no other properties or // edges, then the vertex will effectively not get imported into Neptune Analytics // when preserveDefaultVertexLabels is set to false. PreserveDefaultVertexLabels *bool // Neptune Analytics currently does not support user defined edge ids. The edge // ids are not imported by default. They are imported if preserveEdgeIds is set to // true, and ids are stored as properties on the relationships with the property // name neptuneEdgeId. PreserveEdgeIds *bool // contains filtered or unexported fields }
Options for how to import Neptune data.
type NodeStructure ¶
type NodeStructure struct { // The number of instances of this node. Count *int64 // The outgoing edge labels associated with this node. DistinctOutgoingEdgeLabels []string // Properties associated with this node. NodeProperties []string // contains filtered or unexported fields }
Information about a node.
type PlanCacheType ¶
type PlanCacheType string
const ( PlanCacheTypeEnabled PlanCacheType = "ENABLED" PlanCacheTypeDisabled PlanCacheType = "DISABLED" PlanCacheTypeAuto PlanCacheType = "AUTO" )
Enum values for PlanCacheType
func (PlanCacheType) Values ¶
func (PlanCacheType) Values() []PlanCacheType
Values returns all known values for PlanCacheType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PrivateGraphEndpointStatus ¶
type PrivateGraphEndpointStatus string
const ( PrivateGraphEndpointStatusCreating PrivateGraphEndpointStatus = "CREATING" PrivateGraphEndpointStatusAvailable PrivateGraphEndpointStatus = "AVAILABLE" PrivateGraphEndpointStatusDeleting PrivateGraphEndpointStatus = "DELETING" PrivateGraphEndpointStatusFailed PrivateGraphEndpointStatus = "FAILED" )
Enum values for PrivateGraphEndpointStatus
func (PrivateGraphEndpointStatus) Values ¶
func (PrivateGraphEndpointStatus) Values() []PrivateGraphEndpointStatus
Values returns all known values for PrivateGraphEndpointStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type PrivateGraphEndpointSummary ¶
type PrivateGraphEndpointSummary struct { // The status of the private graph endpoint. // // This member is required. Status PrivateGraphEndpointStatus // The subnet IDs associated with the private graph endpoint. // // This member is required. SubnetIds []string // The ID of the VPC in which the private graph endpoint is located. // // This member is required. VpcId *string // The ID of the VPC endpoint. VpcEndpointId *string // contains filtered or unexported fields }
Details about a private graph endpoint.
type QueryLanguage ¶
type QueryLanguage string
const (
QueryLanguageOpenCypher QueryLanguage = "OPEN_CYPHER"
)
Enum values for QueryLanguage
func (QueryLanguage) Values ¶
func (QueryLanguage) Values() []QueryLanguage
Values returns all known values for QueryLanguage. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QueryState ¶
type QueryState string
const ( QueryStateRunning QueryState = "RUNNING" QueryStateWaiting QueryState = "WAITING" QueryStateCancelling QueryState = "CANCELLING" )
Enum values for QueryState
func (QueryState) Values ¶
func (QueryState) Values() []QueryState
Values returns all known values for QueryState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QueryStateInput ¶
type QueryStateInput string
const ( QueryStateInputAll QueryStateInput = "ALL" QueryStateInputRunning QueryStateInput = "RUNNING" QueryStateInputWaiting QueryStateInput = "WAITING" QueryStateInputCancelling QueryStateInput = "CANCELLING" )
Enum values for QueryStateInput
func (QueryStateInput) Values ¶
func (QueryStateInput) Values() []QueryStateInput
Values returns all known values for QueryStateInput. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type QuerySummary ¶
type QuerySummary struct { // The running time of the query, in milliseconds. Elapsed *int32 // A string representation of the id of the query. Id *string // The actual query text. The queryString may be truncated if the actual query // string is too long. QueryString *string // State of the query. State QueryState // The amount of time, in milliseconds, the query has waited in the queue before // being picked up by a worker thread. Waited *int32 // contains filtered or unexported fields }
Details of the query listed.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
A specified resource could not be located.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string ResourceId *string ResourceType *string ServiceCode *string QuotaCode *string // contains filtered or unexported fields }
A service quota was exceeded.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type SnapshotStatus ¶
type SnapshotStatus string
const ( SnapshotStatusCreating SnapshotStatus = "CREATING" SnapshotStatusAvailable SnapshotStatus = "AVAILABLE" SnapshotStatusDeleting SnapshotStatus = "DELETING" SnapshotStatusFailed SnapshotStatus = "FAILED" )
Enum values for SnapshotStatus
func (SnapshotStatus) Values ¶
func (SnapshotStatus) Values() []SnapshotStatus
Values returns all known values for SnapshotStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The exception was interrupted by throttling.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type UnprocessableException ¶
type UnprocessableException struct { Message *string ErrorCodeOverride *string Reason UnprocessableExceptionReason // contains filtered or unexported fields }
Request cannot be processed due to known reasons. Eg. partition full.
func (*UnprocessableException) Error ¶
func (e *UnprocessableException) Error() string
func (*UnprocessableException) ErrorCode ¶
func (e *UnprocessableException) ErrorCode() string
func (*UnprocessableException) ErrorFault ¶
func (e *UnprocessableException) ErrorFault() smithy.ErrorFault
func (*UnprocessableException) ErrorMessage ¶
func (e *UnprocessableException) ErrorMessage() string
type UnprocessableExceptionReason ¶
type UnprocessableExceptionReason string
const ( UnprocessableExceptionReasonQueryTimeout UnprocessableExceptionReason = "QUERY_TIMEOUT" UnprocessableExceptionReasonInternalLimitExceeded UnprocessableExceptionReason = "INTERNAL_LIMIT_EXCEEDED" UnprocessableExceptionReasonMemoryLimitExceeded UnprocessableExceptionReason = "MEMORY_LIMIT_EXCEEDED" UnprocessableExceptionReasonStorageLimitExceeded UnprocessableExceptionReason = "STORAGE_LIMIT_EXCEEDED" UnprocessableExceptionReasonPartitionFull UnprocessableExceptionReason = "PARTITION_FULL" )
Enum values for UnprocessableExceptionReason
func (UnprocessableExceptionReason) Values ¶
func (UnprocessableExceptionReason) Values() []UnprocessableExceptionReason
Values returns all known values for UnprocessableExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string Reason ValidationExceptionReason // contains filtered or unexported fields }
A resource could not be validated.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReasonConstraintViolation ValidationExceptionReason = "CONSTRAINT_VIOLATION" ValidationExceptionReasonIllegalArgument ValidationExceptionReason = "ILLEGAL_ARGUMENT" ValidationExceptionReasonMalformedQuery ValidationExceptionReason = "MALFORMED_QUERY" ValidationExceptionReasonQueryCancelled ValidationExceptionReason = "QUERY_CANCELLED" ValidationExceptionReasonQueryTooLarge ValidationExceptionReason = "QUERY_TOO_LARGE" ValidationExceptionReasonUnsupportedOperation ValidationExceptionReason = "UNSUPPORTED_OPERATION" ValidationExceptionReasonBadRequest ValidationExceptionReason = "BAD_REQUEST" )
Enum values for ValidationExceptionReason
func (ValidationExceptionReason) Values ¶
func (ValidationExceptionReason) Values() []ValidationExceptionReason
Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.