Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePackageImportJob

Imports a node package.

Request Syntax


POST /packages/import-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InputConfig": { 
      "PackageVersionInputConfig": { 
         "S3Location": { 
            "BucketName": "string",
            "ObjectKey": "string",
            "Region": "string"
         }
      }
   },
   "JobTags": [ 
      { 
         "ResourceType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "JobType": "string",
   "OutputConfig": { 
      "PackageVersionOutputConfig": { 
         "MarkLatest": boolean,
         "PackageName": "string",
         "PackageVersion": "string"
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

A client token for the package import job.

Type: String

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

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

InputConfig

An input config for the package import job.

Type: PackageImportJobInputConfig object

Required: Yes

JobTags

Tags for the package import job.

Type: Array of JobResourceTags objects

Required: No

JobType

A job type for the package import job.

Type: String

Valid Values: NODE_PACKAGE_VERSION | MARKETPLACE_NODE_PACKAGE_VERSION

Required: Yes

OutputConfig

An output config for the package import job.

Type: PackageImportJobOutputConfig object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "JobId": "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.

JobId

The job's ID.

Type: String

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

Pattern: ^[a-zA-Z0-9\-\_]+$

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