{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-importexport","description":"AWS Import/Export","version":"2010-06-01","base_url":"","endpoints":6,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Import/Export\n@version 2010-06-01\n@endpoints 6\n@toc ?Operation=CancelJob(1), ?Operation=CreateJob(1), ?Operation=GetShippingLabel(1), ?Operation=GetStatus(1), ?Operation=ListJobs(1), ?Operation=UpdateJob(1)\n\n@group ?Operation=CancelJob\n@endpoint POST /?Operation=CancelJob\n@desc This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.\n@required {JobId: str}\n@optional {APIVersion: str}\n@returns(200) {Success: bool?}\n@errors {500: The JOBID was missing, not found, or not associated with the AWS account., 500: Indicates that the specified job has expired out of the system., 500: The specified job ID has been canceled and is no longer valid., 500: AWS Import/Export cannot cancel the job, 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The client tool version is invalid.}\n\n@endgroup\n\n@group ?Operation=CreateJob\n@endpoint POST /?Operation=CreateJob\n@desc This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.\n@required {JobType: str, Manifest: str, ValidateOnly: bool}\n@optional {ManifestAddendum: str, APIVersion: str}\n@returns(200) {JobId: str?, JobType: str?, Signature: str?, SignatureFileContents: str?, WarningMessage: str?, ArtifactList: [Artifact]?}\n@errors {500: One or more required parameters was missing from the request., 500: One or more parameters had an invalid value., 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The address specified in the manifest is invalid., 500: One or more manifest fields was invalid. Please correct and resubmit., 500: One or more required fields were missing from the manifest file. Please correct and resubmit., 500: The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to., 500: One or more required customs parameters was missing from the manifest., 500: One or more customs parameters was invalid. Please correct and resubmit., 500: File system specified in export manifest is invalid., 500: Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit., 500: The account specified does not have the appropriate bucket permissions., 500: Your manifest is not well-formed., 500: Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case., 500: The JOBID was missing, not found, or not associated with the AWS account., 500: The client tool version is invalid.}\n\n@endgroup\n\n@group ?Operation=GetShippingLabel\n@endpoint POST /?Operation=GetShippingLabel\n@desc This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.\n@required {jobIds: [str]}\n@optional {name: str, company: str, phoneNumber: str, country: str, stateOrProvince: str, city: str, postalCode: str, street1: str, street2: str, street3: str, APIVersion: str}\n@returns(200) {ShippingLabelURL: str?, Warning: str?}\n@errors {500: The JOBID was missing, not found, or not associated with the AWS account., 500: Indicates that the specified job has expired out of the system., 500: The specified job ID has been canceled and is no longer valid., 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The address specified in the manifest is invalid., 500: The client tool version is invalid., 500: One or more parameters had an invalid value.}\n\n@endgroup\n\n@group ?Operation=GetStatus\n@endpoint POST /?Operation=GetStatus\n@desc This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.\n@required {JobId: str}\n@optional {APIVersion: str}\n@returns(200) {JobId: str?, JobType: str?, LocationCode: str?, LocationMessage: str?, ProgressCode: str?, ProgressMessage: str?, Carrier: str?, TrackingNumber: str?, LogBucket: str?, LogKey: str?, ErrorCount: int?, Signature: str?, SignatureFileContents: str?, CurrentManifest: str?, CreationDate: str(timestamp)?, ArtifactList: [Artifact]?}\n@errors {500: The JOBID was missing, not found, or not associated with the AWS account., 500: Indicates that the specified job has expired out of the system., 500: The specified job ID has been canceled and is no longer valid., 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The client tool version is invalid.}\n\n@endgroup\n\n@group ?Operation=ListJobs\n@endpoint POST /?Operation=ListJobs\n@desc This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.\n@optional {MaxJobs: int, Marker: str, APIVersion: str}\n@returns(200) {Jobs: [Job]?, IsTruncated: bool?}\n@errors {500: One or more parameters had an invalid value., 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The client tool version is invalid.}\n\n@endgroup\n\n@group ?Operation=UpdateJob\n@endpoint POST /?Operation=UpdateJob\n@desc You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.\n@required {JobId: str, Manifest: str, JobType: str, ValidateOnly: bool}\n@optional {APIVersion: str}\n@returns(200) {Success: bool?, WarningMessage: str?, ArtifactList: [Artifact]?}\n@errors {500: One or more required parameters was missing from the request., 500: One or more parameters had an invalid value., 500: The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID., 500: The address specified in the manifest is invalid., 500: One or more manifest fields was invalid. Please correct and resubmit., 500: The JOBID was missing, not found, or not associated with the AWS account., 500: One or more required fields were missing from the manifest file. Please correct and resubmit., 500: The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to., 500: Indicates that the specified job has expired out of the system., 500: The specified job ID has been canceled and is no longer valid., 500: One or more required customs parameters was missing from the manifest., 500: One or more customs parameters was invalid. Please correct and resubmit., 500: File system specified in export manifest is invalid., 500: Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit., 500: The account specified does not have the appropriate bucket permissions., 500: Your manifest is not well-formed., 500: AWS Import/Export cannot update the job, 500: The client tool version is invalid.}\n\n@endgroup\n\n@end\n"}