AWS neptune documentation change
Summary
Added comprehensive code examples for get-loader-job-status and list-loader-jobs API calls using AWS CLI, SDK (Python), awscurl, and curl methods
Security assessment
This change adds routine documentation examples for API usage patterns. There is no evidence of addressing security vulnerabilities, weaknesses, or incidents. The examples include standard AWS credential configuration notes and endpoint URLs, but these are standard operational examples rather than security-focused documentation. The change improves developer experience by providing multiple implementation approaches.
Diff
diff --git a/neptune/latest/userguide/load-api-reference-status-examples.md b/neptune/latest/userguide/load-api-reference-status-examples.md index d88b4b089..e91890116 100644 --- a//neptune/latest/userguide/load-api-reference-status-examples.md +++ b//neptune/latest/userguide/load-api-reference-status-examples.md @@ -14,0 +15,44 @@ The following is a request sent via HTTP `GET` using the `curl` command. +AWS CLI + + + + aws neptunedata get-loader-job-status \ + --endpoint-url https://your-neptune-endpoint:port \ + --load-id loadId (a UUID) + +For more information, see [get-loader-job-status](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-loader-job-status.html) in the AWS CLI Command Reference. + +SDK + + + + import boto3 + from botocore.config import Config + + client = boto3.client( + 'neptunedata', + endpoint_url='https://your-neptune-endpoint:port', + config=Config(read_timeout=None, retries={'total_max_attempts': 1}) + ) + + response = client.get_loader_job_status( + loadId='loadId (a UUID)' + ) + + print(response) + +awscurl + + + + awscurl 'https://your-neptune-endpoint:port/loader/loadId (a UUID)' \ + --region us-east-1 \ + --service neptune-db + +###### Note + +This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster. + +curl + + @@ -47,0 +92,44 @@ The following is a request sent via HTTP `GET` using the `curl` command. +AWS CLI + + + + aws neptunedata list-loader-jobs \ + --endpoint-url https://your-neptune-endpoint:port \ + --limit 3 + +For more information, see [list-loader-jobs](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/list-loader-jobs.html) in the AWS CLI Command Reference. + +SDK + + + + import boto3 + from botocore.config import Config + + client = boto3.client( + 'neptunedata', + endpoint_url='https://your-neptune-endpoint:port', + config=Config(read_timeout=None, retries={'total_max_attempts': 1}) + ) + + response = client.list_loader_jobs( + limit=3 + ) + + print(response) + +awscurl + + + + awscurl 'https://your-neptune-endpoint:port/loader?limit=3' \ + --region us-east-1 \ + --service neptune-db + +###### Note + +This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster. + +curl + + @@ -68,0 +157,46 @@ The following is a request sent via HTTP `GET` using the `curl` command. +AWS CLI + + + + aws neptunedata get-loader-job-status \ + --endpoint-url https://your-neptune-endpoint:port \ + --load-id loadId (a UUID) \ + --details + +For more information, see [get-loader-job-status](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-loader-job-status.html) in the AWS CLI Command Reference. + +SDK + + + + import boto3 + from botocore.config import Config + + client = boto3.client( + 'neptunedata', + endpoint_url='https://your-neptune-endpoint:port', + config=Config(read_timeout=None, retries={'total_max_attempts': 1}) + ) + + response = client.get_loader_job_status( + loadId='loadId (a UUID)', + details=True + ) + + print(response) + +awscurl + + + + awscurl 'https://your-neptune-endpoint:port/loader/loadId (a UUID)?details=true' \ + --region us-east-1 \ + --service neptune-db + +###### Note + +This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster. + +curl + +