AWS.Artifact — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Artifact

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This reference provides descriptions of the low-level AWS Artifact Service API.

Sending a Request Using Artifact

var artifact = new AWS.Artifact();
artifact.getAccountSettings(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Artifact object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var artifact = new AWS.Artifact({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the artifact service identifier:

AWS.config.apiVersions = {
  artifact: '2018-05-10',
  // other service API versions
};

var artifact = new AWS.Artifact();

Constructor Summarycollapse

• new AWS.Artifact(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• getAccountSettings(params = {}, callback) ⇒ AWS.Request
  Get the account settings for Artifact.
  .
• getReport(params = {}, callback) ⇒ AWS.Request
  Get the content for a single report.
  .
• getReportMetadata(params = {}, callback) ⇒ AWS.Request
  Get the metadata for a single report.
  .
• getTermForReport(params = {}, callback) ⇒ AWS.Request
  Get the Term content associated with a single report.
  .
• listReports(params = {}, callback) ⇒ AWS.Request
  List available reports.
  .
• putAccountSettings(params = {}, callback) ⇒ AWS.Request
  Put the account settings for Artifact.
  .
• waitFor(state, params = {}, callback) ⇒ AWS.Request
  Waits for a given Artifact resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Artifact(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Get the account settings for Artifact.

getReport(params = {}, callback) ⇒ AWS.Request

Get the content for a single report.

getReportMetadata(params = {}, callback) ⇒ AWS.Request

Get the metadata for a single report.

getTermForReport(params = {}, callback) ⇒ AWS.Request

Get the Term content associated with a single report.

putAccountSettings(params = {}, callback) ⇒ AWS.Request

Put the account settings for Artifact.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Artifact resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.