Creates a request for an operation on a given service witha set of input parameters.

Triggered when a request is being validated. Listenersshould throw an error if the request should not be sent.

Examples:

var req = s3.putObject(params);req.on('validate', function() {  if (!req.params.Body.match(/^Hello\s/)) {    throw new Error('Body must start with "Hello "');  }});req.send(function(err, data) { ... });

Triggered when the request payload is being built. Listenersshould fill the necessary information to send the requestover HTTP.

Examples:

var req = s3.putObject(params);req.on('build', function() {  req.httpRequest.headers['Custom-Header'] = 'value';});req.send(function(err, data) { ... });

Triggered when the request is being signed. Listeners shouldadd the correct authentication headers and/or adjust the body,depending on the authentication mechanism being used.

Triggered when the request is ready to be sent. Listenersshould call the underlying transport layer to initiatethe sending of the request.

Triggered when a request failed and might need to be retried or redirected.If the response is retryable, the listener should set theresponse.error.retryable property totrue, and optionally setresponse.error.retryDelay to the millisecond delay for the next attempt.In the case of a redirect,response.error.redirect should be set totrue withretryDelay set to an optional delay on the next request.

If a listener decides that a request should not be retried,it should set bothretryable andredirect to false.

Note that a retryable error will be retried at mostConfig.maxRetries times (based on the service object's config).Similarly, a request that is redirected will only redirect at mostConfig.maxRedirects times.

Examples:

request.on('retry', function(response) {  // this resource is not yet available, wait 10 seconds to get it again  if (response.httpResponse.statusCode === 404 && response.error) {    response.error.retryable = true;   // retry this error    response.error.retryDelay = 10000; // wait 10 seconds  }});

Triggered on all non-2xx requests so that listeners can extracterror details from the response body. Listeners to this eventshould set theresponse.error property.

Triggered in successful requests to allow listeners tode-serialize the response body intoresponse.data.

Triggered when the request completed successfully.response.data will contain the response data andresponse.error will be null.

Triggered when an error occurs at any point during therequest.response.error will contain details about the errorthat occurred.response.data will be null.

Triggered whenever a request cycle completes.response.errorshould be checked, since the request may have failed.

Triggered when headers are sent by the remote server

Triggered when data is sent by the remote server

Triggered when the HTTP request has uploaded more data

Triggered when the HTTP request has downloaded more data

Triggered when the HTTP request failed

Triggered when the server is finished sending data

Returns the raw HTTP request objectcontaining request headers and body informationsent by the service.

Returns the time that the request started.

Aborts a request, emitting the error and complete events.

Examples:

var params = {  Bucket: 'bucket', Key: 'key',  Body: Buffer.alloc(1024 * 1024 * 5) // 5MB payload};var request = s3.putObject(params);request.send(function (err, data) {  if (err) console.log("Error:", err.code, err.message);  else console.log(data);});// abort request in 1 secondsetTimeout(request.abort.bind(request), 1000);// prints "Error: RequestAbortedError Request aborted by user"

Sends the request and converts the request object into a readable streamthat can be read from or piped into a writable stream.

Examples:

request.createReadStream().on('data', function(data) {  console.log("Got data:", data.toString());});

var out = fs.createWriteStream('/path/to/outfile.jpg');s3.service.getObject(params).createReadStream().pipe(out);

This function is part of anexperimental API. You can use this function, but it may be removed or be changed in the future.

Enumerates over individual items of a request, paging the responses ifnecessary.

Iterates over each page of results given a pageable request, callingthe provided callback with each page of data. After all pages have beenretrieved, the callback is called withnull data.

Examples:

var pages = 1;s3.listObjects().eachPage(function(err, data) {  if (err) return;  console.log("Page", pages++);  console.log(data);});

s3.listObjects(params).eachPage(function(err, data, done) {  doSomethingAsyncAndOrExpensive(function() {    // The next page of results isn't fetched until done is called    done();  });});

Returns whether the operation can return multiple pages ofresponse data.

Sends the request and returns a 'thenable' promise.

Two callbacks can be provided to thethen method on the returned promise.The first callback will be called if the promise is fulfilled, and the secondcallback will be called if the promise is rejected.

Examples:

var request = s3.putObject({Bucket: 'bucket', Key: 'key'});var result = request.promise();result.then(function(data) { ... }, function(error) { ... });

request = s3.putObject({Bucket: 'bucket', Key: 'key'});request.send(function(err, data) { console.log(err, data); });

request = s3.putObject({Bucket: 'bucket', Key: 'key'});request.on('complete', function(response) { ... }); // register a callbackrequest.send();

Callback (callback):

• function(err, data) { ... }

  If a callback is supplied, it is called when a response is returnedfrom the service.

  Context (this):

  • (AWS.Request) —

    the request object being sent.

  Parameters:

  • err(Error) —

    the error object returned from the request.Set tonull if the request is successful.

  • data(Object) —

    the de-serialized data returned fromthe request. Set tonull if a request error occurs.