DescribePackageImportJob
Returns information about a package import job.
Request Syntax
GET /packages/import-jobs/JobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- JobId
-
The job's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ClientToken": "string",
"CreatedTime": number,
"InputConfig": {
"PackageVersionInputConfig": {
"S3Location": {
"BucketName": "string",
"ObjectKey": "string",
"Region": "string"
}
}
},
"JobId": "string",
"JobTags": [
{
"ResourceType": "string",
"Tags": {
"string" : "string"
}
}
],
"JobType": "string",
"LastUpdatedTime": number,
"Output": {
"OutputS3Location": {
"BucketName": "string",
"ObjectKey": "string"
},
"PackageId": "string",
"PackageVersion": "string",
"PatchVersion": "string"
},
"OutputConfig": {
"PackageVersionOutputConfig": {
"MarkLatest": boolean,
"PackageName": "string",
"PackageVersion": "string"
}
},
"Status": "string",
"StatusMessage": "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.
- ClientToken
-
The job's client token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9\-\_]+$ - CreatedTime
-
When the job was created.
Type: Timestamp
- InputConfig
-
The job's input config.
Type: PackageImportJobInputConfig object
- JobId
-
The job's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_]+$ - JobTags
-
The job's tags.
Type: Array of JobResourceTags objects
- JobType
-
The job's type.
Type: String
Valid Values:
NODE_PACKAGE_VERSION | MARKETPLACE_NODE_PACKAGE_VERSION - LastUpdatedTime
-
When the job was updated.
Type: Timestamp
- Output
-
The job's output.
Type: PackageImportJobOutput object
- OutputConfig
-
The job's output config.
Type: PackageImportJobOutputConfig object
- Status
-
The job's status.
Type: String
Valid Values:
PENDING | SUCCEEDED | FAILED - StatusMessage
-
The job's status message.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
- ConflictException
-
The target resource is in use.
HTTP Status Code: 409
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
