graph_snapshots

Creates, updates, deletes, gets or lists a graph_snapshots resource.

Overview

Name	graph_snapshots
Type	Resource
Id	aws.neptune_graph.graph_snapshots

Fields

The following fields are returned by SELECT queries:

get_graph_snapshot

Name	Datatype	Description
id	string	The unique identifier of the graph snapshot. (pattern: <code>gs-[a-z0-9]{10}</code>)
name	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. Only lowercase letters are allowed. (pattern: <code>(?!gs-)[a-z][a-z0-9](-[a-z0-9]+)</code>)
arn	string	The ARN of the graph snapshot.
kms_key_identifier	string	The ID of the KMS key used to encrypt and decrypt the snapshot. (pattern: <code>arn:aws[^:]:kms:[a-zA-Z0-9-]:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
snapshot_create_time	string (date-time)	The time when the snapshot was created.
source_graph_id	string	The graph identifier for the graph for which a snapshot is to be created. (pattern: <code>g-[a-z0-9]{10}</code>)
status	string	The status of the graph snapshot. (CREATING, AVAILABLE, DELETING, FAILED)

list_graph_snapshots

Name	Datatype	Description
id	string	The unique identifier of the graph snapshot. (pattern: <code>gs-[a-z0-9]{10}</code>)
name	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. Only lowercase letters are allowed. (pattern: <code>(?!gs-)[a-z][a-z0-9](-[a-z0-9]+)</code>)
arn	string	The ARN of the graph snapshot.
kms_key_identifier	string	The ID of the KMS key used to encrypt and decrypt the snapshot. (pattern: <code>arn:aws[^:]:kms:[a-zA-Z0-9-]:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
snapshot_create_time	string (date-time)	The time when the snapshot was created.
source_graph_id	string	The graph identifier for the graph for which a snapshot is to be created. (pattern: <code>g-[a-z0-9]{10}</code>)
status	string	The status of the graph snapshot. (CREATING, AVAILABLE, DELETING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_graph_snapshot	select	snapshot_identifier, region		Retrieves a specified graph snapshot.
list_graph_snapshots	select	region	graphIdentifier, nextToken, maxResults	Lists available snapshots of a specified Neptune Analytics graph.
create_graph_snapshot	insert	region, graphIdentifier, snapshotName		Creates a snapshot of the specific graph.
delete_graph_snapshot	delete	snapshot_identifier, region		Deletes the specified graph snapshot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
snapshot_identifier	string	ID of the graph snapshot to be deleted.
graphIdentifier	string	The unique identifier of the Neptune Analytics graph.
maxResults	integer	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.
nextToken	string	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.

SELECT examples

get_graph_snapshot

Retrieves a specified graph snapshot.

SELECT
id,
name,
arn,
kms_key_identifier,
snapshot_create_time,
source_graph_id,
status
FROM aws.neptune_graph.graph_snapshots
WHERE snapshot_identifier = '{{ snapshot_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_graph_snapshots

Lists available snapshots of a specified Neptune Analytics graph.

SELECT
id,
name,
arn,
kms_key_identifier,
snapshot_create_time,
source_graph_id,
status
FROM aws.neptune_graph.graph_snapshots
WHERE region = '{{ region }}' -- required
AND graphIdentifier = '{{ graphIdentifier }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_graph_snapshot

Creates a snapshot of the specific graph.

INSERT INTO aws.neptune_graph.graph_snapshots (
graphIdentifier,
snapshotName,
tags,
region
)
SELECT 
'{{ graphIdentifier }}' /* required */,
'{{ snapshotName }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
name,
arn,
kms_key_identifier,
snapshot_create_time,
source_graph_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: graph_snapshots
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the graph_snapshots resource.
  - name: graphIdentifier
    value: "{{ graphIdentifier }}"
  - name: snapshotName
    value: "{{ snapshotName }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_graph_snapshot

Deletes the specified graph snapshot.

DELETE FROM aws.neptune_graph.graph_snapshots
WHERE snapshot_identifier = '{{ snapshot_identifier }}' --required
AND region = '{{ region }}' --required
;