StartExportTask - NeptuneAnalyticsAPI
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

StartExportTask

Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.

Request Syntax

POST /exporttasks HTTP/1.1
Content-type: application/json

{
   "destination": "string",
   "exportFilter": { 
      "edgeFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      },
      "vertexFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      }
   },
   "format": "string",
   "graphIdentifier": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

destination

The Amazon S3 URI where data will be exported to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

exportFilter

The export filter of the export task.

Type: ExportFilter object

Required: No

format

The format of the export task.

Type: String

Valid Values: PARQUET | CSV

Required: Yes

graphIdentifier

The source graph identifier of the export task.

Type: String

Pattern: g-[a-z0-9]{10}

Required: Yes

kmsKeyIdentifier

The KMS key identifier of the export task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Required: Yes

parquetType

The parquet type of the export task.

Type: String

Valid Values: COLUMNAR

Required: No

roleArn

The ARN of the IAM role that will allow data to be exported to the destination.

Type: String

Pattern: arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+

Required: Yes

tags

Tags to be applied to the export task.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 201
Content-type: application/json

{
   "destination": "string",
   "exportFilter": { 
      "edgeFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      },
      "vertexFilter": { 
         "string" : { 
            "properties": { 
               "string" : { 
                  "multiValueHandling": "string",
                  "outputType": "string",
                  "sourcePropertyName": "string"
               }
            }
         }
      }
   },
   "format": "string",
   "graphId": "string",
   "kmsKeyIdentifier": "string",
   "parquetType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReason": "string",
   "taskId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

destination

The Amazon S3 URI of the export task where data will be exported to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

exportFilter

The export filter of the export task.

Type: ExportFilter object

format

The format of the export task.

Type: String

Valid Values: PARQUET | CSV

graphId

The source graph identifier of the export task.

Type: String

Pattern: g-[a-z0-9]{10}

kmsKeyIdentifier

The KMS key identifier of the export task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

parquetType

The parquet type of the export task.

Type: String

Valid Values: COLUMNAR

roleArn

The ARN of the IAM role that will allow data to be exported to the destination.

Type: String

Pattern: arn:aws[^:]*:iam::\d{12}:(role|role/service-role)(/[\w+=,.@-]+)+

status

The current status of the export task.

Type: String

Valid Values: INITIALIZING | EXPORTING | SUCCEEDED | FAILED | CANCELLING | CANCELLED | DELETED

statusReason

The reason that the export task has this status value.

Type: String

taskId

The unique identifier of the export task.

Type: String

Pattern: t-[a-z0-9]{10}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Raised when a conflict is encountered.

HTTP Status Code: 409

InternalServerException

A failure occurred on the server.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be located.

HTTP Status Code: 404

ThrottlingException

The exception was interrupted by throttling.

HTTP Status Code: 429

ValidationException

A resource could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: