github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/importexport/2010-06-01/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "operations": {
     4      "CancelJob": "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.",
     5      "CreateJob": "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.",
     6      "GetShippingLabel": "This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.",
     7      "GetStatus": "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.",
     8      "ListJobs": "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.",
     9      "UpdateJob": "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."
    10    },
    11    "service": "<fullname>AWS Import/Export Service</fullname> AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.",
    12    "shapes": {
    13      "APIVersion": {
    14        "base": "Specifies the version of the client tool.",
    15        "refs": {
    16          "CancelJobInput$APIVersion": null,
    17          "CreateJobInput$APIVersion": null,
    18          "GetShippingLabelInput$APIVersion": null,
    19          "GetStatusInput$APIVersion": null,
    20          "ListJobsInput$APIVersion": null,
    21          "UpdateJobInput$APIVersion": null
    22        }
    23      },
    24      "Artifact": {
    25        "base": "A discrete item that contains the description and URL of an artifact (such as a PDF).",
    26        "refs": {
    27          "ArtifactList$member": null
    28        }
    29      },
    30      "ArtifactList": {
    31        "base": "A collection of artifacts.",
    32        "refs": {
    33          "CreateJobOutput$ArtifactList": null,
    34          "GetStatusOutput$ArtifactList": null,
    35          "UpdateJobOutput$ArtifactList": null
    36        }
    37      },
    38      "BucketPermissionException": {
    39        "base": "The account specified does not have the appropriate bucket permissions.",
    40        "refs": {
    41        }
    42      },
    43      "CancelJobInput": {
    44        "base": "Input structure for the CancelJob operation.",
    45        "refs": {
    46        }
    47      },
    48      "CancelJobOutput": {
    49        "base": "Output structure for the CancelJob operation.",
    50        "refs": {
    51        }
    52      },
    53      "CanceledJobIdException": {
    54        "base": "The specified job ID has been canceled and is no longer valid.",
    55        "refs": {
    56        }
    57      },
    58      "Carrier": {
    59        "base": "Name of the shipping company. This value is included when the LocationCode is \"Returned\".",
    60        "refs": {
    61          "GetStatusOutput$Carrier": null
    62        }
    63      },
    64      "CreateJobInput": {
    65        "base": "Input structure for the CreateJob operation.",
    66        "refs": {
    67        }
    68      },
    69      "CreateJobOutput": {
    70        "base": "Output structure for the CreateJob operation.",
    71        "refs": {
    72        }
    73      },
    74      "CreateJobQuotaExceededException": {
    75        "base": "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.",
    76        "refs": {
    77        }
    78      },
    79      "CreationDate": {
    80        "base": "Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\".",
    81        "refs": {
    82          "GetStatusOutput$CreationDate": null,
    83          "Job$CreationDate": null
    84        }
    85      },
    86      "CurrentManifest": {
    87        "base": "The last manifest submitted, which will be used to process the job.",
    88        "refs": {
    89          "GetStatusOutput$CurrentManifest": null
    90        }
    91      },
    92      "Description": {
    93        "base": "The associated description for this object.",
    94        "refs": {
    95          "Artifact$Description": null
    96        }
    97      },
    98      "ErrorCount": {
    99        "base": "Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.",
   100        "refs": {
   101          "GetStatusOutput$ErrorCount": null
   102        }
   103      },
   104      "ErrorMessage": {
   105        "base": "The human-readable description of a particular error.",
   106        "refs": {
   107          "BucketPermissionException$message": null,
   108          "CanceledJobIdException$message": null,
   109          "CreateJobQuotaExceededException$message": null,
   110          "ExpiredJobIdException$message": null,
   111          "InvalidAccessKeyIdException$message": null,
   112          "InvalidAddressException$message": null,
   113          "InvalidCustomsException$message": null,
   114          "InvalidFileSystemException$message": null,
   115          "InvalidJobIdException$message": null,
   116          "InvalidManifestFieldException$message": null,
   117          "InvalidParameterException$message": null,
   118          "InvalidVersionException$message": null,
   119          "MalformedManifestException$message": null,
   120          "MissingCustomsException$message": null,
   121          "MissingManifestFieldException$message": null,
   122          "MissingParameterException$message": null,
   123          "MultipleRegionsException$message": null,
   124          "NoSuchBucketException$message": null,
   125          "UnableToCancelJobIdException$message": null,
   126          "UnableToUpdateJobIdException$message": null
   127        }
   128      },
   129      "ExpiredJobIdException": {
   130        "base": "Indicates that the specified job has expired out of the system.",
   131        "refs": {
   132        }
   133      },
   134      "GenericString": {
   135        "base": null,
   136        "refs": {
   137          "GetShippingLabelOutput$ShippingLabelURL": null,
   138          "GetShippingLabelOutput$Warning": null,
   139          "JobIdList$member": null
   140        }
   141      },
   142      "GetShippingLabelInput": {
   143        "base": null,
   144        "refs": {
   145        }
   146      },
   147      "GetShippingLabelOutput": {
   148        "base": null,
   149        "refs": {
   150        }
   151      },
   152      "GetStatusInput": {
   153        "base": "Input structure for the GetStatus operation.",
   154        "refs": {
   155        }
   156      },
   157      "GetStatusOutput": {
   158        "base": "Output structure for the GetStatus operation.",
   159        "refs": {
   160        }
   161      },
   162      "InvalidAccessKeyIdException": {
   163        "base": "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.",
   164        "refs": {
   165        }
   166      },
   167      "InvalidAddressException": {
   168        "base": "The address specified in the manifest is invalid.",
   169        "refs": {
   170        }
   171      },
   172      "InvalidCustomsException": {
   173        "base": "One or more customs parameters was invalid. Please correct and resubmit.",
   174        "refs": {
   175        }
   176      },
   177      "InvalidFileSystemException": {
   178        "base": "File system specified in export manifest is invalid.",
   179        "refs": {
   180        }
   181      },
   182      "InvalidJobIdException": {
   183        "base": "The JOBID was missing, not found, or not associated with the AWS account.",
   184        "refs": {
   185        }
   186      },
   187      "InvalidManifestFieldException": {
   188        "base": "One or more manifest fields was invalid. Please correct and resubmit.",
   189        "refs": {
   190        }
   191      },
   192      "InvalidParameterException": {
   193        "base": "One or more parameters had an invalid value.",
   194        "refs": {
   195        }
   196      },
   197      "InvalidVersionException": {
   198        "base": "The client tool version is invalid.",
   199        "refs": {
   200        }
   201      },
   202      "IsCanceled": {
   203        "base": "Indicates whether the job was canceled.",
   204        "refs": {
   205          "Job$IsCanceled": null
   206        }
   207      },
   208      "IsTruncated": {
   209        "base": "Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker.",
   210        "refs": {
   211          "ListJobsOutput$IsTruncated": null
   212        }
   213      },
   214      "Job": {
   215        "base": "Representation of a job returned by the ListJobs operation.",
   216        "refs": {
   217          "JobsList$member": null
   218        }
   219      },
   220      "JobId": {
   221        "base": "A unique identifier which refers to a particular job.",
   222        "refs": {
   223          "CancelJobInput$JobId": null,
   224          "CreateJobOutput$JobId": null,
   225          "GetStatusInput$JobId": null,
   226          "GetStatusOutput$JobId": null,
   227          "Job$JobId": null,
   228          "UpdateJobInput$JobId": null
   229        }
   230      },
   231      "JobIdList": {
   232        "base": null,
   233        "refs": {
   234          "GetShippingLabelInput$jobIds": null
   235        }
   236      },
   237      "JobType": {
   238        "base": "Specifies whether the job to initiate is an import or export job.",
   239        "refs": {
   240          "CreateJobInput$JobType": null,
   241          "CreateJobOutput$JobType": null,
   242          "GetStatusOutput$JobType": null,
   243          "Job$JobType": null,
   244          "UpdateJobInput$JobType": null
   245        }
   246      },
   247      "JobsList": {
   248        "base": "A list container for Jobs returned by the ListJobs operation.",
   249        "refs": {
   250          "ListJobsOutput$Jobs": null
   251        }
   252      },
   253      "ListJobsInput": {
   254        "base": "Input structure for the ListJobs operation.",
   255        "refs": {
   256        }
   257      },
   258      "ListJobsOutput": {
   259        "base": "Output structure for the ListJobs operation.",
   260        "refs": {
   261        }
   262      },
   263      "LocationCode": {
   264        "base": "A token representing the location of the storage device, such as \"AtAWS\".",
   265        "refs": {
   266          "GetStatusOutput$LocationCode": null
   267        }
   268      },
   269      "LocationMessage": {
   270        "base": "A more human readable form of the physical location of the storage device.",
   271        "refs": {
   272          "GetStatusOutput$LocationMessage": null
   273        }
   274      },
   275      "LogBucket": {
   276        "base": "Amazon S3 bucket for user logs.",
   277        "refs": {
   278          "GetStatusOutput$LogBucket": null
   279        }
   280      },
   281      "LogKey": {
   282        "base": "The key where the user logs were stored.",
   283        "refs": {
   284          "GetStatusOutput$LogKey": null
   285        }
   286      },
   287      "MalformedManifestException": {
   288        "base": "Your manifest is not well-formed.",
   289        "refs": {
   290        }
   291      },
   292      "Manifest": {
   293        "base": "The UTF-8 encoded text of the manifest file.",
   294        "refs": {
   295          "CreateJobInput$Manifest": null,
   296          "UpdateJobInput$Manifest": null
   297        }
   298      },
   299      "ManifestAddendum": {
   300        "base": "For internal use only.",
   301        "refs": {
   302          "CreateJobInput$ManifestAddendum": null
   303        }
   304      },
   305      "Marker": {
   306        "base": "Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs.",
   307        "refs": {
   308          "ListJobsInput$Marker": null
   309        }
   310      },
   311      "MaxJobs": {
   312        "base": "Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains &lt;IsTruncated&gt;true&lt;/IsTruncated&gt;. To return the additional jobs, see Marker.",
   313        "refs": {
   314          "ListJobsInput$MaxJobs": null
   315        }
   316      },
   317      "MissingCustomsException": {
   318        "base": "One or more required customs parameters was missing from the manifest.",
   319        "refs": {
   320        }
   321      },
   322      "MissingManifestFieldException": {
   323        "base": "One or more required fields were missing from the manifest file. Please correct and resubmit.",
   324        "refs": {
   325        }
   326      },
   327      "MissingParameterException": {
   328        "base": "One or more required parameters was missing from the request.",
   329        "refs": {
   330        }
   331      },
   332      "MultipleRegionsException": {
   333        "base": "Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.",
   334        "refs": {
   335        }
   336      },
   337      "NoSuchBucketException": {
   338        "base": "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.",
   339        "refs": {
   340        }
   341      },
   342      "ProgressCode": {
   343        "base": "A token representing the state of the job, such as \"Started\".",
   344        "refs": {
   345          "GetStatusOutput$ProgressCode": null
   346        }
   347      },
   348      "ProgressMessage": {
   349        "base": "A more human readable form of the job status.",
   350        "refs": {
   351          "GetStatusOutput$ProgressMessage": null
   352        }
   353      },
   354      "Signature": {
   355        "base": "An encrypted code used to authenticate the request and response, for example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value.",
   356        "refs": {
   357          "CreateJobOutput$Signature": null,
   358          "GetStatusOutput$Signature": null,
   359          "GetStatusOutput$SignatureFileContents": null
   360        }
   361      },
   362      "SignatureFileContents": {
   363        "base": "The actual text of the SIGNATURE file to be written to disk.",
   364        "refs": {
   365          "CreateJobOutput$SignatureFileContents": null
   366        }
   367      },
   368      "Success": {
   369        "base": "Specifies whether (true) or not (false) AWS Import/Export updated your job.",
   370        "refs": {
   371          "CancelJobOutput$Success": null,
   372          "UpdateJobOutput$Success": null
   373        }
   374      },
   375      "TrackingNumber": {
   376        "base": "The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is \"Returned\".",
   377        "refs": {
   378          "GetStatusOutput$TrackingNumber": null
   379        }
   380      },
   381      "URL": {
   382        "base": "The URL for a given Artifact.",
   383        "refs": {
   384          "Artifact$URL": null
   385        }
   386      },
   387      "UnableToCancelJobIdException": {
   388        "base": "AWS Import/Export cannot cancel the job",
   389        "refs": {
   390        }
   391      },
   392      "UnableToUpdateJobIdException": {
   393        "base": "AWS Import/Export cannot update the job",
   394        "refs": {
   395        }
   396      },
   397      "UpdateJobInput": {
   398        "base": "Input structure for the UpateJob operation.",
   399        "refs": {
   400        }
   401      },
   402      "UpdateJobOutput": {
   403        "base": "Output structure for the UpateJob operation.",
   404        "refs": {
   405        }
   406      },
   407      "ValidateOnly": {
   408        "base": "Validate the manifest and parameter values in the request but do not actually create a job.",
   409        "refs": {
   410          "CreateJobInput$ValidateOnly": null,
   411          "UpdateJobInput$ValidateOnly": null
   412        }
   413      },
   414      "WarningMessage": {
   415        "base": "An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.",
   416        "refs": {
   417          "CreateJobOutput$WarningMessage": null,
   418          "UpdateJobOutput$WarningMessage": null
   419        }
   420      },
   421      "city": {
   422        "base": "Specifies the name of your city for the return address.",
   423        "refs": {
   424          "GetShippingLabelInput$city": null
   425        }
   426      },
   427      "company": {
   428        "base": "Specifies the name of the company that will ship this package.",
   429        "refs": {
   430          "GetShippingLabelInput$company": null
   431        }
   432      },
   433      "country": {
   434        "base": "Specifies the name of your country for the return address.",
   435        "refs": {
   436          "GetShippingLabelInput$country": null
   437        }
   438      },
   439      "name": {
   440        "base": "Specifies the name of the person responsible for shipping this package.",
   441        "refs": {
   442          "GetShippingLabelInput$name": null
   443        }
   444      },
   445      "phoneNumber": {
   446        "base": "Specifies the phone number of the person responsible for shipping this package.",
   447        "refs": {
   448          "GetShippingLabelInput$phoneNumber": null
   449        }
   450      },
   451      "postalCode": {
   452        "base": "Specifies the postal code for the return address.",
   453        "refs": {
   454          "GetShippingLabelInput$postalCode": null
   455        }
   456      },
   457      "stateOrProvince": {
   458        "base": "Specifies the name of your state or your province for the return address.",
   459        "refs": {
   460          "GetShippingLabelInput$stateOrProvince": null
   461        }
   462      },
   463      "street1": {
   464        "base": "Specifies the first part of the street address for the return address, for example 1234 Main Street.",
   465        "refs": {
   466          "GetShippingLabelInput$street1": null
   467        }
   468      },
   469      "street2": {
   470        "base": "Specifies the optional second part of the street address for the return address, for example Suite 100.",
   471        "refs": {
   472          "GetShippingLabelInput$street2": null
   473        }
   474      },
   475      "street3": {
   476        "base": "Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.",
   477        "refs": {
   478          "GetShippingLabelInput$street3": null
   479        }
   480      }
   481    }
   482  }