neptunegraph

package module
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2024 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Overview

Package neptunegraph provides the API client, operations, and parameter types for Amazon Neptune Graph.

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-11-29"
View Source 
const ServiceID = "Neptune Graph"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelImportTaskInput 

type CancelImportTaskInput struct {

	// The unique identifier of the import task.
	//
	// This member is required.
	TaskIdentifier *string
	// contains filtered or unexported fields
}

type CancelImportTaskOutput 

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

	// Current status of the task. Status is CANCELLING when the import task is
	// cancelled.
	//
	// This member is required.
	Status types.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 (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)
	// or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)
	// .
	Format types.Format

	// The unique identifier of the Neptune Analytics graph.
	GraphId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelQueryInput added in v1.2.0 

type CancelQueryInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The unique identifier of the query to cancel.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type CancelQueryOutput added in v1.2.0 

type CancelQueryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Neptune Graph.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelImportTask 

func (c *Client) CancelImportTask(ctx context.Context, params *CancelImportTaskInput, optFns ...func(*Options)) (*CancelImportTaskOutput, error)

Deletes the specified import task.

func (*Client) CancelQuery added in v1.2.0 

func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optFns ...func(*Options)) (*CancelQueryOutput, error)

Cancels a specified query.

func (*Client) CreateGraph 

func (c *Client) CreateGraph(ctx context.Context, params *CreateGraphInput, optFns ...func(*Options)) (*CreateGraphOutput, error)

Creates a new Neptune Analytics graph.

func (*Client) CreateGraphSnapshot 

func (c *Client) CreateGraphSnapshot(ctx context.Context, params *CreateGraphSnapshotInput, optFns ...func(*Options)) (*CreateGraphSnapshotOutput, error)

Creates a snapshot of the specific graph.

func (*Client) CreateGraphUsingImportTask 

func (c *Client) CreateGraphUsingImportTask(ctx context.Context, params *CreateGraphUsingImportTaskInput, optFns ...func(*Options)) (*CreateGraphUsingImportTaskOutput, error)

Creates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune database snapshot. The data can be loaded from files in S3 that in either the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) or the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) .

func (*Client) CreatePrivateGraphEndpoint 

func (c *Client) CreatePrivateGraphEndpoint(ctx context.Context, params *CreatePrivateGraphEndpointInput, optFns ...func(*Options)) (*CreatePrivateGraphEndpointOutput, error)

Create a private graph endpoint to allow private access from to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.

func (*Client) DeleteGraph 

func (c *Client) DeleteGraph(ctx context.Context, params *DeleteGraphInput, optFns ...func(*Options)) (*DeleteGraphOutput, error)

Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.

func (*Client) DeleteGraphSnapshot 

func (c *Client) DeleteGraphSnapshot(ctx context.Context, params *DeleteGraphSnapshotInput, optFns ...func(*Options)) (*DeleteGraphSnapshotOutput, error)

Deletes the specifed graph snapshot.

func (*Client) DeletePrivateGraphEndpoint 

func (c *Client) DeletePrivateGraphEndpoint(ctx context.Context, params *DeletePrivateGraphEndpointInput, optFns ...func(*Options)) (*DeletePrivateGraphEndpointOutput, error)

Deletes a private graph endpoint.

func (*Client) ExecuteQuery added in v1.2.0 

func (c *Client) ExecuteQuery(ctx context.Context, params *ExecuteQueryInput, optFns ...func(*Options)) (*ExecuteQueryOutput, error)

Execute an openCypher query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

  • neptune-graph:ReadDataViaQuery
  • neptune-graph:WriteDataViaQuery
  • neptune-graph:DeleteDataViaQuery

func (*Client) GetGraph 

func (c *Client) GetGraph(ctx context.Context, params *GetGraphInput, optFns ...func(*Options)) (*GetGraphOutput, error)

Gets information about a specified graph.

func (*Client) GetGraphSnapshot 

func (c *Client) GetGraphSnapshot(ctx context.Context, params *GetGraphSnapshotInput, optFns ...func(*Options)) (*GetGraphSnapshotOutput, error)

Retrieves a specified graph snapshot.

func (*Client) GetGraphSummary added in v1.2.0 

func (c *Client) GetGraphSummary(ctx context.Context, params *GetGraphSummaryInput, optFns ...func(*Options)) (*GetGraphSummaryOutput, error)

Gets a graph summary for a property graph.

func (*Client) GetImportTask 

func (c *Client) GetImportTask(ctx context.Context, params *GetImportTaskInput, optFns ...func(*Options)) (*GetImportTaskOutput, error)

Retrieves a specified import task.

func (*Client) GetPrivateGraphEndpoint 

func (c *Client) GetPrivateGraphEndpoint(ctx context.Context, params *GetPrivateGraphEndpointInput, optFns ...func(*Options)) (*GetPrivateGraphEndpointOutput, error)

Retrieves information about a specified private endpoint.

func (*Client) GetQuery added in v1.2.0 

func (c *Client) GetQuery(ctx context.Context, params *GetQueryInput, optFns ...func(*Options)) (*GetQueryOutput, error)

Retrieves the status of a specified query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the neptune-graph:GetQueryStatus IAM action attached.

func (*Client) ListGraphSnapshots 

func (c *Client) ListGraphSnapshots(ctx context.Context, params *ListGraphSnapshotsInput, optFns ...func(*Options)) (*ListGraphSnapshotsOutput, error)

Lists available snapshots of a specified Neptune Analytics graph.

func (*Client) ListGraphs 

func (c *Client) ListGraphs(ctx context.Context, params *ListGraphsInput, optFns ...func(*Options)) (*ListGraphsOutput, error)

Lists available Neptune Analytics graphs.

func (*Client) ListImportTasks 

func (c *Client) ListImportTasks(ctx context.Context, params *ListImportTasksInput, optFns ...func(*Options)) (*ListImportTasksOutput, error)

Lists import tasks.

func (*Client) ListPrivateGraphEndpoints 

func (c *Client) ListPrivateGraphEndpoints(ctx context.Context, params *ListPrivateGraphEndpointsInput, optFns ...func(*Options)) (*ListPrivateGraphEndpointsOutput, error)

Lists private endpoints for a specified Neptune Analytics graph.

func (*Client) ListQueries added in v1.2.0 

func (c *Client) ListQueries(ctx context.Context, params *ListQueriesInput, optFns ...func(*Options)) (*ListQueriesOutput, error)

Lists active openCypher queries.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists tags associated with a specified resource.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) ResetGraph 

func (c *Client) ResetGraph(ctx context.Context, params *ResetGraphInput, optFns ...func(*Options)) (*ResetGraphOutput, error)

Empties the data from a specified Neptune Analytics graph.

func (*Client) RestoreGraphFromSnapshot 

func (c *Client) RestoreGraphFromSnapshot(ctx context.Context, params *RestoreGraphFromSnapshotInput, optFns ...func(*Options)) (*RestoreGraphFromSnapshotOutput, error)

Restores a graph from a snapshot.

func (*Client) StartImportTask added in v1.8.0 

func (c *Client) StartImportTask(ctx context.Context, params *StartImportTaskInput, optFns ...func(*Options)) (*StartImportTaskOutput, error)

Import data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to the specified resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the specified tags from the specified resource.

func (*Client) UpdateGraph 

func (c *Client) UpdateGraph(ctx context.Context, params *UpdateGraphInput, optFns ...func(*Options)) (*UpdateGraphOutput, error)

Updates the configuration of a specified Neptune Analytics graph

type CreateGraphInput 

type CreateGraphInput struct {

	// A name for the new Neptune Analytics graph to be created. 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.
	GraphName *string

	// The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the
	// graph. Min = 128
	//
	// This member is required.
	ProvisionedMemory *int32

	// Indicates whether or not to enable deletion protection on the graph. The graph
	// can’t be deleted when deletion protection is enabled. ( true or false ).
	DeletionProtection *bool

	// Specifies a KMS key to use to encrypt data in the new graph.
	KmsKeyIdentifier *string

	// Specifies whether or not the graph can be reachable over the internet. All
	// access to graphs is IAM authenticated. ( true to enable, or false to disable.
	PublicConnectivity *bool

	// The number of replicas in other AZs. Min =0, Max = 2, Default = 1. Additional
	// charges equivalent to the m-NCUs selected for the graph apply for each replica.
	ReplicaCount *int32

	// Adds metadata tags to the new graph. These tags can also be used with cost
	// allocation reporting, or used in a Condition statement in an IAM policy.
	Tags map[string]string

	// Specifies the number of dimensions for vector embeddings that will be loaded
	// into the graph. The value is specified as dimension= value. Max = 65,535
	VectorSearchConfiguration *types.VectorSearchConfiguration
	// contains filtered or unexported fields
}

type CreateGraphOutput 

type CreateGraphOutput struct {

	// The ARN of the graph.
	//
	// This member is required.
	Arn *string

	// The ID of the graph.
	//
	// This member is required.
	Id *string

	// The graph name. For example: my-graph-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 build number of the graph software.
	BuildNumber *string

	// The time when the graph was created.
	CreateTime *time.Time

	// A value that indicates whether the graph has deletion protection enabled. The
	// graph can't be deleted when deletion protection is enabled.
	DeletionProtection *bool

	// The graph endpoint.
	Endpoint *string

	// Specifies the KMS key used to encrypt data in the new graph.
	KmsKeyIdentifier *string

	// The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the
	// graph. Min = 128
	ProvisionedMemory *int32

	// Specifies whether or not the graph can be reachable over the internet. All
	// access to graphs is IAM authenticated. If enabling public connectivity for the
	// first time, there will be a delay while it is enabled.
	PublicConnectivity *bool

	// The number of replicas in other AZs. Default: If not specified, the default
	// value is 1.
	ReplicaCount *int32

	// The ID of the source graph.
	SourceSnapshotId *string

	// The current status of the graph.
	Status types.GraphStatus

	// The reason the status was given.
	StatusReason *string

	// The vector-search configuration for the graph, which specifies the vector
	// dimension to use in the vector index, if any.
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGraphSnapshotInput 

type CreateGraphSnapshotInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *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.
	SnapshotName *string

	// Adds metadata tags to the new graph. These tags can also be used with cost
	// allocation reporting, or used in a Condition statement in an IAM policy.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateGraphSnapshotOutput 

type CreateGraphSnapshotOutput struct {

	// The ARN of the snapshot created.
	//
	// This member is required.
	Arn *string

	// The ID of the snapshot created.
	//
	// This member is required.
	Id *string

	// The name of the snapshot created.
	//
	// This member is required.
	Name *string

	// The ID of the KMS key used to encrypt and decrypt graph data.
	KmsKeyIdentifier *string

	// The snapshot creation time
	SnapshotCreateTime *time.Time

	// The Id of the Neptune Analytics graph from which the snapshot is created.
	SourceGraphId *string

	// The current state of the snapshot.
	Status types.SnapshotStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGraphUsingImportTaskInput 

type CreateGraphUsingImportTaskInput struct {

	// A name for the new Neptune Analytics graph to be created. 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.
	GraphName *string

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

	// Indicates whether or not to enable deletion protection on the graph. The graph
	// can’t be deleted when deletion protection is enabled. ( true or false ).
	DeletionProtection *bool

	// If set to true , the task halts when an import error is encountered. If set to
	// false , the task skips the data that caused the error and continues if possible.
	FailOnError *bool

	// Specifies the format of S3 data to be imported. Valid values are CSV , which
	// identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)
	// or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)
	// .
	Format types.Format

	// Contains options for controlling the import process. For example, if the
	// failOnError key is set to false , the import skips problem data and attempts to
	// continue (whereas if set to true , the default, or if omitted, the import
	// operation halts immediately when an error is encountered.
	ImportOptions types.ImportOptions

	// Specifies a KMS key to use to encrypt data imported into the new graph.
	KmsKeyIdentifier *string

	// The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use
	// for the graph. Default: 1024, or the approved upper limit for your account. If
	// both the minimum and maximum values are specified, the max of the
	// min-provisioned-memory and max-provisioned memory is used to create the graph.
	// If neither value is specified 128 m-NCUs are used.
	MaxProvisionedMemory *int32

	// The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use
	// for the graph. Default: 128
	MinProvisionedMemory *int32

	// Specifies whether or not the graph can be reachable over the internet. All
	// access to graphs is IAM authenticated. ( true to enable, or false to disable).
	PublicConnectivity *bool

	// The number of replicas in other AZs to provision on the new graph after import.
	// Default = 0, Min = 0, Max = 2. Additional charges equivalent to the m-NCUs
	// selected for the graph apply for each replica.
	ReplicaCount *int32

	// Adds metadata tags to the new graph. These tags can also be used with cost
	// allocation reporting, or used in a Condition statement in an IAM policy.
	Tags map[string]string

	// Specifies the number of dimensions for vector embeddings that will be loaded
	// into the graph. The value is specified as dimension= value. Max = 65,535
	VectorSearchConfiguration *types.VectorSearchConfiguration
	// contains filtered or unexported fields
}

type CreateGraphUsingImportTaskOutput 

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

	// The status of the import task.
	//
	// This member is required.
	Status types.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 (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)
	// or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)
	// .
	Format types.Format

	// The unique identifier of the Neptune Analytics graph.
	GraphId *string

	// Contains options for controlling the import process. For example, if the
	// failOnError key is set to false , the import skips problem data and attempts to
	// continue (whereas if set to true , the default, or if omitted, the import
	// operation halts immediately when an error is encountered.
	ImportOptions types.ImportOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePrivateGraphEndpointInput 

type CreatePrivateGraphEndpointInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// Subnets in which private graph endpoint ENIs are created.
	SubnetIds []string

	// The VPC in which the private graph endpoint needs to be created.
	VpcId *string

	// Security groups to be attached to the private graph endpoint..
	VpcSecurityGroupIds []string
	// contains filtered or unexported fields
}

type CreatePrivateGraphEndpointOutput 

type CreatePrivateGraphEndpointOutput struct {

	// Status of the private graph endpoint.
	//
	// This member is required.
	Status types.PrivateGraphEndpointStatus

	// Subnets in which the private graph endpoint ENIs are created.
	//
	// This member is required.
	SubnetIds []string

	// VPC in which the private graph endpoint is created.
	//
	// This member is required.
	VpcId *string

	// Endpoint ID of the prviate grpah endpoint.
	VpcEndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGraphInput 

type DeleteGraphInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// Determines whether a final graph snapshot is created before the graph is
	// deleted. If true is specified, no graph snapshot is created. If false is
	// specified, a graph snapshot is created before the graph is deleted.
	//
	// This member is required.
	SkipSnapshot *bool
	// contains filtered or unexported fields
}

type DeleteGraphOutput 

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

	// The build number associated with the graph.
	BuildNumber *string

	// The time at which the graph was created.
	CreateTime *time.Time

	// If true , deletion protection was 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 ID of the snapshot from which the graph was created, if the graph was
	// recovered from a snapshot.
	SourceSnapshotId *string

	// The status of the graph.
	Status types.GraphStatus

	// The reason for the status of the graph.
	StatusReason *string

	// Specifies the number of dimensions for vector embeddings loaded into the graph.
	// Max = 65535
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGraphSnapshotInput 

type DeleteGraphSnapshotInput struct {

	// ID of the graph snapshot to be deleted.
	//
	// This member is required.
	SnapshotIdentifier *string
	// contains filtered or unexported fields
}

type DeleteGraphSnapshotOutput 

type DeleteGraphSnapshotOutput 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 from which the snapshot was created.
	SourceGraphId *string

	// The status of the graph snapshot.
	Status types.SnapshotStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePrivateGraphEndpointInput 

type DeletePrivateGraphEndpointInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The ID of the VPC where the private endpoint is located.
	//
	// This member is required.
	VpcId *string
	// contains filtered or unexported fields
}

type DeletePrivateGraphEndpointOutput 

type DeletePrivateGraphEndpointOutput struct {

	// The status of the delete operation.
	//
	// This member is required.
	Status types.PrivateGraphEndpointStatus

	// The subnet IDs involved.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC where the private endpoint was deleted.
	//
	// This member is required.
	VpcId *string

	// The ID of the VPC endpoint that was deleted.
	VpcEndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// Parameter to determine whether current API is a control plane or dataplane API
	ApiType *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExecuteQueryInput added in v1.2.0 

type ExecuteQueryInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The query language the query is written in. Currently only openCypher is
	// supported.
	//
	// This member is required.
	Language types.QueryLanguage

	// The query string to be executed.
	//
	// This member is required.
	QueryString *string

	// The explain mode parameter returns a query explain instead of the actual query
	// results. A query explain can be used to gather insights about the query
	// execution such as planning decisions, time spent on each operator, solutions
	// flowing etc.
	ExplainMode types.ExplainMode

	// The data parameters the query can use in JSON format. For example: {"name":
	// "john", "age": 20}. (optional)
	Parameters map[string]document.Interface

	// Query plan cache is a feature that saves the query plan and reuses it on
	// successive executions of the same query. This reduces query latency, and works
	// for both READ and UPDATE queries. The plan cache is an LRU cache with a 5
	// minute TTL and a capacity of 1000.
	PlanCache types.PlanCacheType

	// Specifies the query timeout duration, in milliseconds. (optional)
	QueryTimeoutMilliseconds *int32
	// contains filtered or unexported fields
}

type ExecuteQueryOutput added in v1.2.0 

type ExecuteQueryOutput struct {

	// The query results.
	//
	// This member is required.
	Payload io.ReadCloser

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGraphAPIClient added in v1.1.0 

type GetGraphAPIClient interface {
	GetGraph(context.Context, *GetGraphInput, ...func(*Options)) (*GetGraphOutput, error)
}

GetGraphAPIClient is a client that implements the GetGraph operation.

type GetGraphInput 

type GetGraphInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string
	// contains filtered or unexported fields
}

type GetGraphOutput 

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

	// The build number of the graph.
	BuildNumber *string

	// The time at which the graph was created.
	CreateTime *time.Time

	// 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 ID of the snapshot from which the graph was created, if it was created from
	// a snapshot.
	SourceSnapshotId *string

	// The status of the graph.
	Status types.GraphStatus

	// The reason that the graph has this status.
	StatusReason *string

	// Specifies the number of dimensions for vector embeddings loaded into the graph.
	// Max = 65535
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGraphSnapshotAPIClient added in v1.1.0 

type GetGraphSnapshotAPIClient interface {
	GetGraphSnapshot(context.Context, *GetGraphSnapshotInput, ...func(*Options)) (*GetGraphSnapshotOutput, error)
}

GetGraphSnapshotAPIClient is a client that implements the GetGraphSnapshot operation.

type GetGraphSnapshotInput 

type GetGraphSnapshotInput struct {

	// The ID of the snapshot to retrieve.
	//
	// This member is required.
	SnapshotIdentifier *string
	// contains filtered or unexported fields
}

type GetGraphSnapshotOutput 

type GetGraphSnapshotOutput 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 types.SnapshotStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGraphSummaryInput added in v1.2.0 

type GetGraphSummaryInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The summary mode can take one of two values: basic (the default), and detailed .
	Mode types.GraphSummaryMode
	// contains filtered or unexported fields
}

type GetGraphSummaryOutput added in v1.2.0 

type GetGraphSummaryOutput struct {

	// The graph summary.
	GraphSummary *types.GraphDataSummary

	// The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last
	// computed statistics.
	LastStatisticsComputationTime *time.Time

	// Display the version of this tool.
	Version *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetImportTaskAPIClient added in v1.1.0 

type GetImportTaskAPIClient interface {
	GetImportTask(context.Context, *GetImportTaskInput, ...func(*Options)) (*GetImportTaskOutput, error)
}

GetImportTaskAPIClient is a client that implements the GetImportTask operation.

type GetImportTaskInput 

type GetImportTaskInput struct {

	// The unique identifier of the import task.
	//
	// This member is required.
	TaskIdentifier *string
	// contains filtered or unexported fields
}

type GetImportTaskOutput 

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

	// The status of the import task:
	//   - INITIALIZING – The necessary resources needed to create the graph are being
	//   prepared.
	//   - ANALYZING_DATA – The data is being analyzed to determine the optimal
	//   infrastructure configuration for the new graph.
	//   - RE_PROVISIONING – The data did not fit into the provisioned graph, so it is
	//   being re-provisioned with more capacity.
	//   - IMPORTING – The data is being loaded.
	//   - ERROR_ENCOUNTERED – An error has been encountered while trying to create
	//   the graph and import the data.
	//   - ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered,
	//   the graph is being rolled back and all its resources released.
	//   - SUCCEEDED – Graph creation and data loading succeeded.
	//   - FAILED – Graph creation or data loading failed. When the status is FAILED ,
	//   you can use get-graphs to get more information about the state of the graph.
	//   - CANCELLING – Because you cancelled the import task, cancellation is in
	//   progress.
	//   - CANCELLED – You have successfully cancelled the import task.
	//
	// This member is required.
	Status types.ImportTaskStatus

	// The unique identifier of the import task.
	//
	// This member is required.
	TaskId *string

	// The number of the current attempt to execute the import task.
	AttemptNumber *int32

	// Specifies the format of S3 data to be imported. Valid values are CSV , which
	// identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html)
	// or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html)
	// .
	Format types.Format

	// The unique identifier of the Neptune Analytics graph.
	GraphId *string

	// Contains options for controlling the import process. For example, if the
	// failOnError key is set to false , the import skips problem data and attempts to
	// continue (whereas if set to true , the default, or if omitted, the import
	// operation halts immediately when an error is encountered.
	ImportOptions types.ImportOptions

	// Contains details about the specified import task.
	ImportTaskDetails *types.ImportTaskDetails

	// The reason that the import task has this status value.
	StatusReason *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPrivateGraphEndpointAPIClient added in v1.1.0 

type GetPrivateGraphEndpointAPIClient interface {
	GetPrivateGraphEndpoint(context.Context, *GetPrivateGraphEndpointInput, ...func(*Options)) (*GetPrivateGraphEndpointOutput, error)
}

GetPrivateGraphEndpointAPIClient is a client that implements the GetPrivateGraphEndpoint operation.

type GetPrivateGraphEndpointInput 

type GetPrivateGraphEndpointInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The ID of the VPC where the private endpoint is located.
	//
	// This member is required.
	VpcId *string
	// contains filtered or unexported fields
}

type GetPrivateGraphEndpointOutput 

type GetPrivateGraphEndpointOutput struct {

	// The current status of the private endpoint.
	//
	// This member is required.
	Status types.PrivateGraphEndpointStatus

	// The subnet IDs involved.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the VPC where the private endpoint is located.
	//
	// This member is required.
	VpcId *string

	// The ID of the private endpoint.
	VpcEndpointId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetQueryInput added in v1.2.0 

type GetQueryInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The ID of the query in question.
	//
	// This member is required.
	QueryId *string
	// contains filtered or unexported fields
}

type GetQueryOutput added in v1.2.0 

type GetQueryOutput struct {

	// The number of milliseconds the query has been running.
	Elapsed *int32

	// The ID of the query in question.
	Id *string

	// The query in question.
	QueryString *string

	// State of the query.
	State types.QueryState

	// Indicates how long the query waited, in milliseconds.
	Waited *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GraphAvailableWaiter added in v1.1.0 

type GraphAvailableWaiter struct {
	// contains filtered or unexported fields
}

GraphAvailableWaiter defines the waiters for GraphAvailable

func NewGraphAvailableWaiter added in v1.1.0 

func NewGraphAvailableWaiter(client GetGraphAPIClient, optFns ...func(*GraphAvailableWaiterOptions)) *GraphAvailableWaiter

NewGraphAvailableWaiter constructs a GraphAvailableWaiter.

func (*GraphAvailableWaiter) Wait added in v1.1.0 

func (w *GraphAvailableWaiter) Wait(ctx context.Context, params *GetGraphInput, maxWaitDur time.Duration, optFns ...func(*GraphAvailableWaiterOptions)) error

Wait calls the waiter function for GraphAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*GraphAvailableWaiter) WaitForOutput added in v1.1.0 

func (w *GraphAvailableWaiter) WaitForOutput(ctx context.Context, params *GetGraphInput, maxWaitDur time.Duration, optFns ...func(*GraphAvailableWaiterOptions)) (*GetGraphOutput, error)

WaitForOutput calls the waiter function for GraphAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type GraphAvailableWaiterOptions added in v1.1.0 

type GraphAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// GraphAvailableWaiter will use default minimum delay of 60 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, GraphAvailableWaiter will use default max delay of 28800 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetGraphInput, *GetGraphOutput, error) (bool, error)
}

GraphAvailableWaiterOptions are waiter options for GraphAvailableWaiter

type GraphDeletedWaiter added in v1.1.0 

type GraphDeletedWaiter struct {
	// contains filtered or unexported fields
}

GraphDeletedWaiter defines the waiters for GraphDeleted

func NewGraphDeletedWaiter added in v1.1.0 

func NewGraphDeletedWaiter(client GetGraphAPIClient, optFns ...func(*GraphDeletedWaiterOptions)) *GraphDeletedWaiter

NewGraphDeletedWaiter constructs a GraphDeletedWaiter.

func (*GraphDeletedWaiter) Wait added in v1.1.0 

func (w *GraphDeletedWaiter) Wait(ctx context.Context, params *GetGraphInput, maxWaitDur time.Duration, optFns ...func(*GraphDeletedWaiterOptions)) error

Wait calls the waiter function for GraphDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*GraphDeletedWaiter) WaitForOutput added in v1.1.0 

func (w *GraphDeletedWaiter) WaitForOutput(ctx context.Context, params *GetGraphInput, maxWaitDur time.Duration, optFns ...func(*GraphDeletedWaiterOptions)) (*GetGraphOutput, error)

WaitForOutput calls the waiter function for GraphDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type GraphDeletedWaiterOptions added in v1.1.0 

type GraphDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// GraphDeletedWaiter will use default minimum delay of 60 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, GraphDeletedWaiter will use default max delay of 3600 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetGraphInput, *GetGraphOutput, error) (bool, error)
}

GraphDeletedWaiterOptions are waiter options for GraphDeletedWaiter

type GraphSnapshotAvailableWaiter added in v1.1.0 

type GraphSnapshotAvailableWaiter struct {
	// contains filtered or unexported fields
}

GraphSnapshotAvailableWaiter defines the waiters for GraphSnapshotAvailable

func NewGraphSnapshotAvailableWaiter added in v1.1.0 

func NewGraphSnapshotAvailableWaiter(client GetGraphSnapshotAPIClient, optFns ...func(*GraphSnapshotAvailableWaiterOptions)) *GraphSnapshotAvailableWaiter

NewGraphSnapshotAvailableWaiter constructs a GraphSnapshotAvailableWaiter.

func (*GraphSnapshotAvailableWaiter) Wait added in v1.1.0 

func (w *GraphSnapshotAvailableWaiter) Wait(ctx context.Context, params *GetGraphSnapshotInput, maxWaitDur time.Duration, optFns ...func(*GraphSnapshotAvailableWaiterOptions)) error

Wait calls the waiter function for GraphSnapshotAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*GraphSnapshotAvailableWaiter) WaitForOutput added in v1.1.0 

func (w *GraphSnapshotAvailableWaiter) WaitForOutput(ctx context.Context, params *GetGraphSnapshotInput, maxWaitDur time.Duration, optFns ...func(*GraphSnapshotAvailableWaiterOptions)) (*GetGraphSnapshotOutput, error)

WaitForOutput calls the waiter function for GraphSnapshotAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type GraphSnapshotAvailableWaiterOptions added in v1.1.0 

type GraphSnapshotAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// GraphSnapshotAvailableWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, GraphSnapshotAvailableWaiter will use default max delay of 7200
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetGraphSnapshotInput, *GetGraphSnapshotOutput, error) (bool, error)
}

GraphSnapshotAvailableWaiterOptions are waiter options for GraphSnapshotAvailableWaiter

type GraphSnapshotDeletedWaiter added in v1.1.0 

type GraphSnapshotDeletedWaiter struct {
	// contains filtered or unexported fields
}

GraphSnapshotDeletedWaiter defines the waiters for GraphSnapshotDeleted

func NewGraphSnapshotDeletedWaiter added in v1.1.0 

func NewGraphSnapshotDeletedWaiter(client GetGraphSnapshotAPIClient, optFns ...func(*GraphSnapshotDeletedWaiterOptions)) *GraphSnapshotDeletedWaiter

NewGraphSnapshotDeletedWaiter constructs a GraphSnapshotDeletedWaiter.

func (*GraphSnapshotDeletedWaiter) Wait added in v1.1.0 

func (w *GraphSnapshotDeletedWaiter) Wait(ctx context.Context, params *GetGraphSnapshotInput, maxWaitDur time.Duration, optFns ...func(*GraphSnapshotDeletedWaiterOptions)) error

Wait calls the waiter function for GraphSnapshotDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*GraphSnapshotDeletedWaiter) WaitForOutput added in v1.1.0 

func (w *GraphSnapshotDeletedWaiter) WaitForOutput(ctx context.Context, params *GetGraphSnapshotInput, maxWaitDur time.Duration, optFns ...func(*GraphSnapshotDeletedWaiterOptions)) (*GetGraphSnapshotOutput, error)

WaitForOutput calls the waiter function for GraphSnapshotDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type GraphSnapshotDeletedWaiterOptions added in v1.1.0 

type GraphSnapshotDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// GraphSnapshotDeletedWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, GraphSnapshotDeletedWaiter will use default max delay of 3600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetGraphSnapshotInput, *GetGraphSnapshotOutput, error) (bool, error)
}

GraphSnapshotDeletedWaiterOptions are waiter options for GraphSnapshotDeletedWaiter

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportTaskCancelledWaiter added in v1.1.0 

type ImportTaskCancelledWaiter struct {
	// contains filtered or unexported fields
}

ImportTaskCancelledWaiter defines the waiters for ImportTaskCancelled

func NewImportTaskCancelledWaiter added in v1.1.0 

func NewImportTaskCancelledWaiter(client GetImportTaskAPIClient, optFns ...func(*ImportTaskCancelledWaiterOptions)) *ImportTaskCancelledWaiter

NewImportTaskCancelledWaiter constructs a ImportTaskCancelledWaiter.

func (*ImportTaskCancelledWaiter) Wait added in v1.1.0 

func (w *ImportTaskCancelledWaiter) Wait(ctx context.Context, params *GetImportTaskInput, maxWaitDur time.Duration, optFns ...func(*ImportTaskCancelledWaiterOptions)) error

Wait calls the waiter function for ImportTaskCancelled waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImportTaskCancelledWaiter) WaitForOutput added in v1.1.0 

func (w *ImportTaskCancelledWaiter) WaitForOutput(ctx context.Context, params *GetImportTaskInput, maxWaitDur time.Duration, optFns ...func(*ImportTaskCancelledWaiterOptions)) (*GetImportTaskOutput, error)

WaitForOutput calls the waiter function for ImportTaskCancelled waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImportTaskCancelledWaiterOptions added in v1.1.0 

type ImportTaskCancelledWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImportTaskCancelledWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImportTaskCancelledWaiter will use default max delay of 3600
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetImportTaskInput, *GetImportTaskOutput, error) (bool, error)
}

ImportTaskCancelledWaiterOptions are waiter options for ImportTaskCancelledWaiter

type ImportTaskSuccessfulWaiter added in v1.1.0 

type ImportTaskSuccessfulWaiter struct {
	// contains filtered or unexported fields
}

ImportTaskSuccessfulWaiter defines the waiters for ImportTaskSuccessful

func NewImportTaskSuccessfulWaiter added in v1.1.0 

func NewImportTaskSuccessfulWaiter(client GetImportTaskAPIClient, optFns ...func(*ImportTaskSuccessfulWaiterOptions)) *ImportTaskSuccessfulWaiter

NewImportTaskSuccessfulWaiter constructs a ImportTaskSuccessfulWaiter.

func (*ImportTaskSuccessfulWaiter) Wait added in v1.1.0 

func (w *ImportTaskSuccessfulWaiter) Wait(ctx context.Context, params *GetImportTaskInput, maxWaitDur time.Duration, optFns ...func(*ImportTaskSuccessfulWaiterOptions)) error

Wait calls the waiter function for ImportTaskSuccessful waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImportTaskSuccessfulWaiter) WaitForOutput added in v1.1.0 

func (w *ImportTaskSuccessfulWaiter) WaitForOutput(ctx context.Context, params *GetImportTaskInput, maxWaitDur time.Duration, optFns ...func(*ImportTaskSuccessfulWaiterOptions)) (*GetImportTaskOutput, error)

WaitForOutput calls the waiter function for ImportTaskSuccessful waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImportTaskSuccessfulWaiterOptions added in v1.1.0 

type ImportTaskSuccessfulWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImportTaskSuccessfulWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImportTaskSuccessfulWaiter will use default max delay of 28800
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetImportTaskInput, *GetImportTaskOutput, error) (bool, error)
}

ImportTaskSuccessfulWaiterOptions are waiter options for ImportTaskSuccessfulWaiter

type ListGraphSnapshotsAPIClient 

type ListGraphSnapshotsAPIClient interface {
	ListGraphSnapshots(context.Context, *ListGraphSnapshotsInput, ...func(*Options)) (*ListGraphSnapshotsOutput, error)
}

ListGraphSnapshotsAPIClient is a client that implements the ListGraphSnapshots operation.

type ListGraphSnapshotsInput 

type ListGraphSnapshotsInput struct {

	// The unique identifier of the Neptune Analytics graph.
	GraphIdentifier *string

	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	MaxResults *int32

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGraphSnapshotsOutput 

type ListGraphSnapshotsOutput struct {

	// The requested list of snapshots.
	//
	// This member is required.
	GraphSnapshots []types.GraphSnapshotSummary

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGraphSnapshotsPaginator 

type ListGraphSnapshotsPaginator struct {
	// contains filtered or unexported fields
}

ListGraphSnapshotsPaginator is a paginator for ListGraphSnapshots

func NewListGraphSnapshotsPaginator 

func NewListGraphSnapshotsPaginator(client ListGraphSnapshotsAPIClient, params *ListGraphSnapshotsInput, optFns ...func(*ListGraphSnapshotsPaginatorOptions)) *ListGraphSnapshotsPaginator

NewListGraphSnapshotsPaginator returns a new ListGraphSnapshotsPaginator

func (*ListGraphSnapshotsPaginator) HasMorePages 

func (p *ListGraphSnapshotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGraphSnapshotsPaginator) NextPage 

func (p *ListGraphSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGraphSnapshotsOutput, error)

NextPage retrieves the next ListGraphSnapshots page.

type ListGraphSnapshotsPaginatorOptions 

type ListGraphSnapshotsPaginatorOptions struct {
	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGraphSnapshotsPaginatorOptions is the paginator options for ListGraphSnapshots

type ListGraphsAPIClient 

type ListGraphsAPIClient interface {
	ListGraphs(context.Context, *ListGraphsInput, ...func(*Options)) (*ListGraphsOutput, error)
}

ListGraphsAPIClient is a client that implements the ListGraphs operation.

type ListGraphsInput 

type ListGraphsInput struct {

	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	MaxResults *int32

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGraphsOutput 

type ListGraphsOutput struct {

	// A list of the graphs.
	//
	// This member is required.
	Graphs []types.GraphSummary

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGraphsPaginator 

type ListGraphsPaginator struct {
	// contains filtered or unexported fields
}

ListGraphsPaginator is a paginator for ListGraphs

func NewListGraphsPaginator 

func NewListGraphsPaginator(client ListGraphsAPIClient, params *ListGraphsInput, optFns ...func(*ListGraphsPaginatorOptions)) *ListGraphsPaginator

NewListGraphsPaginator returns a new ListGraphsPaginator

func (*ListGraphsPaginator) HasMorePages 

func (p *ListGraphsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGraphsPaginator) NextPage 

func (p *ListGraphsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGraphsOutput, error)

NextPage retrieves the next ListGraphs page.

type ListGraphsPaginatorOptions 

type ListGraphsPaginatorOptions struct {
	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGraphsPaginatorOptions is the paginator options for ListGraphs

type ListImportTasksAPIClient 

type ListImportTasksAPIClient interface {
	ListImportTasks(context.Context, *ListImportTasksInput, ...func(*Options)) (*ListImportTasksOutput, error)
}

ListImportTasksAPIClient is a client that implements the ListImportTasks operation.

type ListImportTasksInput 

type ListImportTasksInput struct {

	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	MaxResults *int32

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type ListImportTasksOutput 

type ListImportTasksOutput struct {

	// The requested list of import tasks.
	//
	// This member is required.
	Tasks []types.ImportTaskSummary

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListImportTasksPaginator 

type ListImportTasksPaginator struct {
	// contains filtered or unexported fields
}

ListImportTasksPaginator is a paginator for ListImportTasks

func NewListImportTasksPaginator 

func NewListImportTasksPaginator(client ListImportTasksAPIClient, params *ListImportTasksInput, optFns ...func(*ListImportTasksPaginatorOptions)) *ListImportTasksPaginator

NewListImportTasksPaginator returns a new ListImportTasksPaginator

func (*ListImportTasksPaginator) HasMorePages 

func (p *ListImportTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImportTasksPaginator) NextPage 

func (p *ListImportTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportTasksOutput, error)

NextPage retrieves the next ListImportTasks page.

type ListImportTasksPaginatorOptions 

type ListImportTasksPaginatorOptions struct {
	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListImportTasksPaginatorOptions is the paginator options for ListImportTasks

type ListPrivateGraphEndpointsAPIClient 

type ListPrivateGraphEndpointsAPIClient interface {
	ListPrivateGraphEndpoints(context.Context, *ListPrivateGraphEndpointsInput, ...func(*Options)) (*ListPrivateGraphEndpointsOutput, error)
}

ListPrivateGraphEndpointsAPIClient is a client that implements the ListPrivateGraphEndpoints operation.

type ListPrivateGraphEndpointsInput 

type ListPrivateGraphEndpointsInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	MaxResults *int32

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPrivateGraphEndpointsOutput 

type ListPrivateGraphEndpointsOutput struct {

	// A list of private endpoints for the specified Neptune Analytics graph.
	//
	// This member is required.
	PrivateGraphEndpoints []types.PrivateGraphEndpointSummary

	// Pagination token used to paginate output. When this value is provided as input,
	// the service returns results from where the previous response left off. When this
	// value is present in output, it indicates that there are more results to
	// retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPrivateGraphEndpointsPaginator 

type ListPrivateGraphEndpointsPaginator struct {
	// contains filtered or unexported fields
}

ListPrivateGraphEndpointsPaginator is a paginator for ListPrivateGraphEndpoints

func NewListPrivateGraphEndpointsPaginator 

func NewListPrivateGraphEndpointsPaginator(client ListPrivateGraphEndpointsAPIClient, params *ListPrivateGraphEndpointsInput, optFns ...func(*ListPrivateGraphEndpointsPaginatorOptions)) *ListPrivateGraphEndpointsPaginator

NewListPrivateGraphEndpointsPaginator returns a new ListPrivateGraphEndpointsPaginator

func (*ListPrivateGraphEndpointsPaginator) HasMorePages 

func (p *ListPrivateGraphEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPrivateGraphEndpointsPaginator) NextPage 

func (p *ListPrivateGraphEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrivateGraphEndpointsOutput, error)

NextPage retrieves the next ListPrivateGraphEndpoints page.

type ListPrivateGraphEndpointsPaginatorOptions 

type ListPrivateGraphEndpointsPaginatorOptions struct {
	// The total number of records to return in the command's output. If the total
	// number of records available is more than the value specified, nextToken is
	// provided in the command's output. To resume pagination, provide the nextToken
	// output value in the nextToken argument of a subsequent command. Do not use the
	// nextToken response element directly outside of the Amazon CLI.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPrivateGraphEndpointsPaginatorOptions is the paginator options for ListPrivateGraphEndpoints

type ListQueriesInput added in v1.2.0 

type ListQueriesInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// The maximum number of results to be fetched by the API.
	//
	// This member is required.
	MaxResults *int32

	// Filtered list of queries based on state.
	State types.QueryStateInput
	// contains filtered or unexported fields
}

type ListQueriesOutput added in v1.2.0 

type ListQueriesOutput struct {

	// A list of current openCypher queries.
	//
	// This member is required.
	Queries []types.QuerySummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of metadata tags associated with the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PrivateGraphEndpointAvailableWaiter added in v1.1.0 

type PrivateGraphEndpointAvailableWaiter struct {
	// contains filtered or unexported fields
}

PrivateGraphEndpointAvailableWaiter defines the waiters for PrivateGraphEndpointAvailable

func NewPrivateGraphEndpointAvailableWaiter added in v1.1.0 

func NewPrivateGraphEndpointAvailableWaiter(client GetPrivateGraphEndpointAPIClient, optFns ...func(*PrivateGraphEndpointAvailableWaiterOptions)) *PrivateGraphEndpointAvailableWaiter

NewPrivateGraphEndpointAvailableWaiter constructs a PrivateGraphEndpointAvailableWaiter.

func (*PrivateGraphEndpointAvailableWaiter) Wait added in v1.1.0 

func (w *PrivateGraphEndpointAvailableWaiter) Wait(ctx context.Context, params *GetPrivateGraphEndpointInput, maxWaitDur time.Duration, optFns ...func(*PrivateGraphEndpointAvailableWaiterOptions)) error

Wait calls the waiter function for PrivateGraphEndpointAvailable waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*PrivateGraphEndpointAvailableWaiter) WaitForOutput added in v1.1.0 

func (w *PrivateGraphEndpointAvailableWaiter) WaitForOutput(ctx context.Context, params *GetPrivateGraphEndpointInput, maxWaitDur time.Duration, optFns ...func(*PrivateGraphEndpointAvailableWaiterOptions)) (*GetPrivateGraphEndpointOutput, error)

WaitForOutput calls the waiter function for PrivateGraphEndpointAvailable waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type PrivateGraphEndpointAvailableWaiterOptions added in v1.1.0 

type PrivateGraphEndpointAvailableWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// PrivateGraphEndpointAvailableWaiter will use default minimum delay of 10
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, PrivateGraphEndpointAvailableWaiter will use default max delay of
	// 1800 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetPrivateGraphEndpointInput, *GetPrivateGraphEndpointOutput, error) (bool, error)
}

PrivateGraphEndpointAvailableWaiterOptions are waiter options for PrivateGraphEndpointAvailableWaiter

type PrivateGraphEndpointDeletedWaiter added in v1.1.0 

type PrivateGraphEndpointDeletedWaiter struct {
	// contains filtered or unexported fields
}

PrivateGraphEndpointDeletedWaiter defines the waiters for PrivateGraphEndpointDeleted

func NewPrivateGraphEndpointDeletedWaiter added in v1.1.0 

func NewPrivateGraphEndpointDeletedWaiter(client GetPrivateGraphEndpointAPIClient, optFns ...func(*PrivateGraphEndpointDeletedWaiterOptions)) *PrivateGraphEndpointDeletedWaiter

NewPrivateGraphEndpointDeletedWaiter constructs a PrivateGraphEndpointDeletedWaiter.

func (*PrivateGraphEndpointDeletedWaiter) Wait added in v1.1.0 

func (w *PrivateGraphEndpointDeletedWaiter) Wait(ctx context.Context, params *GetPrivateGraphEndpointInput, maxWaitDur time.Duration, optFns ...func(*PrivateGraphEndpointDeletedWaiterOptions)) error

Wait calls the waiter function for PrivateGraphEndpointDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*PrivateGraphEndpointDeletedWaiter) WaitForOutput added in v1.1.0 

func (w *PrivateGraphEndpointDeletedWaiter) WaitForOutput(ctx context.Context, params *GetPrivateGraphEndpointInput, maxWaitDur time.Duration, optFns ...func(*PrivateGraphEndpointDeletedWaiterOptions)) (*GetPrivateGraphEndpointOutput, error)

WaitForOutput calls the waiter function for PrivateGraphEndpointDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type PrivateGraphEndpointDeletedWaiterOptions added in v1.1.0 

type PrivateGraphEndpointDeletedWaiterOptions struct {

	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// PrivateGraphEndpointDeletedWaiter will use default minimum delay of 10 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, PrivateGraphEndpointDeletedWaiter will use default max delay of
	// 1800 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetPrivateGraphEndpointInput, *GetPrivateGraphEndpointOutput, error) (bool, error)
}

PrivateGraphEndpointDeletedWaiterOptions are waiter options for PrivateGraphEndpointDeletedWaiter

type ResetGraphInput 

type ResetGraphInput struct {

	// ID of the graph to reset.
	//
	// This member is required.
	GraphIdentifier *string

	// Determines whether a final graph snapshot is created before the graph data is
	// deleted. If set to true , no graph snapshot is created. If set to false , a
	// graph snapshot is created before the data is deleted.
	//
	// This member is required.
	SkipSnapshot *bool
	// contains filtered or unexported fields
}

type ResetGraphOutput 

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

	// The build number of the graph.
	BuildNumber *string

	// The time at which the graph was created.
	CreateTime *time.Time

	// 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 ID of the snapshot from which the graph was created, if any.
	SourceSnapshotId *string

	// The status of the graph.
	Status types.GraphStatus

	// The reason that the graph has this status.
	StatusReason *string

	// Specifies the number of dimensions for vector embeddings loaded into the graph.
	// Max = 65535
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RestoreGraphFromSnapshotInput 

type RestoreGraphFromSnapshotInput struct {

	// A name for the new Neptune Analytics graph to be created from the snapshot. 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.
	GraphName *string

	// The ID of the snapshot in question.
	//
	// This member is required.
	SnapshotIdentifier *string

	// A value that indicates whether the graph has deletion protection enabled. The
	// graph can't be deleted when deletion protection is enabled.
	DeletionProtection *bool

	// The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the
	// graph. Min = 128
	ProvisionedMemory *int32

	// Specifies whether or not the graph can be reachable over the internet. All
	// access to graphs is IAM authenticated. ( true to enable, or false to disable).
	PublicConnectivity *bool

	// The number of replicas in other AZs. Min =0, Max = 2, Default =1 Additional
	// charges equivalent to the m-NCUs selected for the graph apply for each replica.
	ReplicaCount *int32

	// Adds metadata tags to the snapshot. These tags can also be used with cost
	// allocation reporting, or used in a Condition statement in an IAM policy.
	Tags map[string]string
	// contains filtered or unexported fields
}

type RestoreGraphFromSnapshotOutput 

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

	// The build number of the graph.
	BuildNumber *string

	// The time at which the graph was created.
	CreateTime *time.Time

	// 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 ID of the snapshot from which the graph was created, if any.
	SourceSnapshotId *string

	// The status of the graph.
	Status types.GraphStatus

	// The reason that the graph has this status.
	StatusReason *string

	// Specifies the number of dimensions for vector embeddings loaded into the graph.
	// Max = 65535
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartImportTaskInput added in v1.8.0 

type StartImportTaskInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

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

	// If set to true, the task halts when an import error is encountered. If set to
	// false, the task skips the data that caused the error and continues if possible.
	FailOnError *bool

	// Specifies the format of Amazon S3 data to be imported. Valid values are CSV,
	// which identifies the Gremlin CSV format or OPENCYPHER, which identies the
	// openCypher load format.
	Format types.Format

	// Options for how to perform an import.
	ImportOptions types.ImportOptions
	// contains filtered or unexported fields
}

type StartImportTaskOutput added in v1.8.0 

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

	// The status of the import task.
	//
	// This member is required.
	Status types.ImportTaskStatus

	// The unique identifier of the import task.
	//
	// This member is required.
	TaskId *string

	// Specifies the format of Amazon S3 data to be imported. Valid values are CSV,
	// which identifies the Gremlin CSV format or OPENCYPHER, which identies the
	// openCypher load format.
	Format types.Format

	// The unique identifier of the Neptune Analytics graph.
	GraphId *string

	// Options for how to perform an import.
	ImportOptions types.ImportOptions

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// ARN of the resource for which tags need to be added.
	//
	// This member is required.
	ResourceArn *string

	// The tags to be assigned to the Neptune Analytics resource. The tags are
	// metadata that are specified as a list of key-value pairs: Key (string) – A key
	// is the required name of the tag. The string value can be from 1 to 128 Unicode
	// characters in length. It can't be prefixed with aws: and can only contain the
	// set of Unicode characters specified by this Java regular expression:
	// "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") . Value (string) – A value is the optional
	// value of the tag. The string value can be from 1 to 256 Unicode characters in
	// length. It can't be prefixed with aws: and can only contain the set of Unicode
	// characters specified by this Java regular expression:
	// "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") .
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// ARN of the resource whose tag needs to be removed.
	//
	// This member is required.
	ResourceArn *string

	// Tag keys for the tags to be removed.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGraphInput 

type UpdateGraphInput struct {

	// The unique identifier of the Neptune Analytics graph.
	//
	// This member is required.
	GraphIdentifier *string

	// A value that indicates whether the graph has deletion protection enabled. The
	// graph can't be deleted when deletion protection is enabled.
	DeletionProtection *bool

	// The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the
	// graph. Min = 128
	ProvisionedMemory *int32

	// Specifies whether or not the graph can be reachable over the internet. All
	// access to graphs is IAM authenticated. ( true to enable, or false to disable.
	PublicConnectivity *bool
	// contains filtered or unexported fields
}

type UpdateGraphOutput 

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

	// The build number of the graph.
	BuildNumber *string

	// The time at which the graph was created.
	CreateTime *time.Time

	// 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 ID of the snapshot from which the graph was created, if any.
	SourceSnapshotId *string

	// The status of the graph.
	Status types.GraphStatus

	// The reason that the graph has this status.
	StatusReason *string

	// Specifies the number of dimensions for vector embeddings loaded into the graph.
	// Max = 65535
	VectorSearchConfiguration *types.VectorSearchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
Package document implements encoding and decoding of open-content that has a JSON-like data model.
 Package document implements encoding and decoding of open-content that has a JSON-like data model.
internal
document
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.