Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
Request Syntax
POST /export-vector-enrichment-jobs HTTP/1.1
Content-type: application/json
{
"Arn": "string",
"ClientToken": "string",
"ExecutionRoleArn": "string",
"OutputConfig": {
"S3Data": {
"KmsKeyId": "string",
"S3Uri": "string"
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Arn
-
The Amazon Resource Name (ARN) of the Vector Enrichment job.
Type: String
Pattern:
^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$Required: Yes
- ClientToken
-
A unique token that guarantees that the call to this API is idempotent.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 64.
Required: No
- ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$Required: Yes
- OutputConfig
-
Output location information for exporting Vector Enrichment Job results.
Type: ExportVectorEnrichmentJobOutputConfig object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationTime": "string",
"ExecutionRoleArn": "string",
"ExportStatus": "string",
"OutputConfig": {
"S3Data": {
"KmsKeyId": "string",
"S3Uri": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
Type: String
Pattern:
^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$ - CreationTime
-
The creation time.
Type: Timestamp
- ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$ - ExportStatus
-
The status of the results the Vector Enrichment job being exported.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED - OutputConfig
-
Output location information for exporting Vector Enrichment Job results.
Type: ExportVectorEnrichmentJobOutputConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
You have exceeded the service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
