You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Outposts

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.Outposts

Identifier:

outposts

API Version:

2019-12-03

Defined in:

(unknown)

Overview

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

Service Description

AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.

Sending a Request Using Outposts

var outposts = new AWS.Outposts();
outposts.createOrder(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 Outposts object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var outposts = new AWS.Outposts({apiVersion: '2019-12-03'});

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

AWS.config.apiVersions = {
  outposts: '2019-12-03',
  // other service API versions
};

var outposts = new AWS.Outposts();

Version:

• 2019-12-03

Constructor Summary

• new AWS.Outposts(options = {}) ⇒ Object constructor

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

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

  Creates an order for an Outpost.

  .

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

  Creates an Outpost.

  You can specify AvailabilityZone or AvailabilityZoneId.

  .

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

  Deletes the Outpost.

  .

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

  Deletes the site.

  .

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

  Gets information about the specified Outpost.

  .

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

  Lists the instance types for the specified Outpost.

  .

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

  Create a list of the Outposts for your AWS account.

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

  Lists the sites for the specified AWS account.

  .

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

  Lists the tags for the specified resource.

  .

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

  Adds tags to the specified resource.

  .

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

  Removes tags from the specified resource.

  .

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Outposts object

var outposts = new AWS.Outposts({apiVersion: '2019-12-03'});

Options Hash (options):

• params (map) —

  An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

• endpoint (String|AWS.Endpoint) —

  The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

• accessKeyId (String) —

  your AWS access key ID.

• secretAccessKey (String) —

  your AWS secret access key.

• sessionToken (AWS.Credentials) —

  the optional AWS session token to sign requests with.

• credentials (AWS.Credentials) —

  the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

• credentialProvider (AWS.CredentialProviderChain) —

  the provider chain used to resolve credentials if no static credentials property is set.

• region (String) —

  the region to send service requests to. See AWS.Outposts.region for more information.

• maxRetries (Integer) —

  the maximum amount of retries to attempt with a request. See AWS.Outposts.maxRetries for more information.

• maxRedirects (Integer) —

  the maximum amount of redirects to follow with a request. See AWS.Outposts.maxRedirects for more information.

• sslEnabled (Boolean) —

  whether to enable SSL for requests.

• paramValidation (Boolean|map) —

  whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

  • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
  • max [Boolean] — Validates that a value meets the max constraint.
  • pattern [Boolean] — Validates that a string value matches a regular expression.
  • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
• computeChecksums (Boolean) —

  whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

• convertResponseTypes (Boolean) —

  whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

• correctClockSkew (Boolean) —

  whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

• s3ForcePathStyle (Boolean) —

  whether to force path style URLs for S3 objects.

• s3BucketEndpoint (Boolean) —

  whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

• s3DisableBodySigning (Boolean) —

  whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

• s3UsEast1RegionalEndpoint ('legacy'|'regional') —

  when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

• s3UseArnRegion (Boolean) —

  whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

• retryDelayOptions (map) —

  A set of options to configure the retry delay on retryable errors. Currently supported options are:

  • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
  • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
• httpOptions (map) —

  A set of options to pass to the low-level HTTP request. Currently supported options are:

  • proxy [String] — the URL to proxy requests through
  • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
  • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
  • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
  • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
  • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
• apiVersion (String, Date) —

  a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

• apiVersions (map<String, String|Date>) —

  a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

• logger (#write, #log) —

  an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

• systemClockOffset (Number) —

  an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

• signatureVersion (String) —

  the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

• signatureCache (Boolean) —

  whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

• dynamoDbCrc32 (Boolean) —

  whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

• useAccelerateEndpoint (Boolean) —

  Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

• clientSideMonitoring (Boolean) —

  whether to collect and publish this client's performance metrics of all its API requests.

• endpointDiscoveryEnabled (Boolean|undefined) —

  whether to call operations with endpoints given by service dynamically. Setting this

• endpointCacheSize (Number) —

  the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

• hostPrefixEnabled (Boolean) —

  whether to marshal request parameters to the prefix of hostname. Defaults to true.

• stsRegionalEndpoints ('legacy'|'regional') —

  whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

• (AWS.Endpoint) —

  an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates an order for an Outpost.

Service Reference:

• CreateOrder

Examples:

Calling the createOrder operation

var params = {
  LineItems: [ /* required */
    {
      CatalogItemId: 'STRING_VALUE',
      Quantity: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  OutpostIdentifier: 'STRING_VALUE', /* required */
  PaymentOption: ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT, /* required */
  PaymentTerm: THREE_YEARS
};
outposts.createOrder(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OutpostIdentifier — (String)

    The ID or the Amazon Resource Name (ARN) of the Outpost.

  • LineItems — (Array<map>)

    The line items that make up the order.

    • CatalogItemId — (String)

      The ID of the catalog item.

    • Quantity — (Integer)

      The quantity of a line item request.

  • PaymentOption — (String)

    The payment option for the order.

    Possible values include:
    • "ALL_UPFRONT"
    • "NO_UPFRONT"
    • "PARTIAL_UPFRONT"
  • PaymentTerm — (String)

    The payment terms for the order.

    Possible values include:
    • "THREE_YEARS"

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Order — (map)

      Information about this order.

      • OutpostId — (String)

        The ID of the Outpost.

      • OrderId — (String)

        The ID of the order.

      • Status — (String)

        The status of the order

        Possible values include:
        • "RECEIVED"
        • "PENDING"
        • "PROCESSING"
        • "INSTALLING"
        • "FULFILLED"
        • "CANCELLED"
      • LineItems — (Array<map>)

        The line items for the order

        • CatalogItemId — (String)

          The ID of the catalog item.

        • LineItemId — (String)

          The ID of the line item.

        • Quantity — (Integer)

          The quantity of the line item.

        • Status — (String)

          The status of the line item.

      • PaymentOption — (String)

        The payment option for the order.

        Possible values include:
        • "ALL_UPFRONT"
        • "NO_UPFRONT"
        • "PARTIAL_UPFRONT"
      • OrderSubmissionDate — (Date)

        The submission date for the order.

      • OrderFulfilledDate — (Date)

        The fulfillment date of the order.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Creates an Outpost.

You can specify AvailabilityZone or AvailabilityZoneId.

Service Reference:

• CreateOutpost

Examples:

Calling the createOutpost operation

var params = {
  Name: 'STRING_VALUE', /* required */
  SiteId: 'STRING_VALUE', /* required */
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
outposts.createOutpost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the Outpost.

  • Description — (String)

    The description of the Outpost.

  • SiteId — (String)

    The ID of the site.

  • AvailabilityZone — (String)

    The Availability Zone.

  • AvailabilityZoneId — (String)

    The ID of the Availability Zone.

  • Tags — (map<String>)

    The tags to apply to the Outpost.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Outpost — (map)

      Information about an Outpost.

      • OutpostId — (String)

        The ID of the Outpost.

      • OwnerId — (String)

        The AWS account ID of the Outpost owner.

      • OutpostArn — (String)

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId — (String)

        The ID of the site.

      • Name — (String)

        The name of the Outpost.

      • Description — (String)

        The description of the Outpost.

      • LifeCycleStatus — (String)

        The life cycle status.

      • AvailabilityZone — (String)

        The Availability Zone.

      • AvailabilityZoneId — (String)

        The ID of the Availability Zone.

      • Tags — (map<String>)

        The Outpost tags.

      • SiteArn — (String)

        The Amazon Resource Name (ARN) of the site.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Deletes the Outpost.

Service Reference:

• DeleteOutpost

Examples:

Calling the deleteOutpost operation

var params = {
  OutpostId: 'STRING_VALUE' /* required */
};
outposts.deleteOutpost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OutpostId — (String)

    The ID of the Outpost.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Deletes the site.

Service Reference:

• DeleteSite

Examples:

Calling the deleteSite operation

var params = {
  SiteId: 'STRING_VALUE' /* required */
};
outposts.deleteSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SiteId — (String)

    The ID of the site.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Gets information about the specified Outpost.

Service Reference:

• GetOutpost

Examples:

Calling the getOutpost operation

var params = {
  OutpostId: 'STRING_VALUE' /* required */
};
outposts.getOutpost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OutpostId — (String)

    The ID of the Outpost.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Outpost — (map)

      Information about an Outpost.

      • OutpostId — (String)

        The ID of the Outpost.

      • OwnerId — (String)

        The AWS account ID of the Outpost owner.

      • OutpostArn — (String)

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId — (String)

        The ID of the site.

      • Name — (String)

        The name of the Outpost.

      • Description — (String)

        The description of the Outpost.

      • LifeCycleStatus — (String)

        The life cycle status.

      • AvailabilityZone — (String)

        The Availability Zone.

      • AvailabilityZoneId — (String)

        The ID of the Availability Zone.

      • Tags — (map<String>)

        The Outpost tags.

      • SiteArn — (String)

        The Amazon Resource Name (ARN) of the site.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Lists the instance types for the specified Outpost.

Service Reference:

• GetOutpostInstanceTypes

Examples:

Calling the getOutpostInstanceTypes operation

var params = {
  OutpostId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
outposts.getOutpostInstanceTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • OutpostId — (String)

    The ID of the Outpost.

  • NextToken — (String)

    The pagination token.

  • MaxResults — (Integer)

    The maximum page size.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InstanceTypes — (Array<map>)

      Information about the instance types.

      • InstanceType — (String)

        The instance type.

    • NextToken — (String)

      The pagination token.

    • OutpostId — (String)

      The ID of the Outpost.

    • OutpostArn — (String)

      The Amazon Resource Name (ARN) of the Outpost.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID (use1-az1).

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

Service Reference:

• ListOutposts

Examples:

Calling the listOutposts operation

var params = {
  AvailabilityZoneFilter: [
    'STRING_VALUE',
    /* more items */
  ],
  AvailabilityZoneIdFilter: [
    'STRING_VALUE',
    /* more items */
  ],
  LifeCycleStatusFilter: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
outposts.listOutposts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    The pagination token.

  • MaxResults — (Integer)

    The maximum page size.

  • LifeCycleStatusFilter — (Array<String>)

    A filter for the lifecycle status of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • AvailabilityZoneFilter — (Array<String>)

    A filter for the Availibility Zone (us-east-1a) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • AvailabilityZoneIdFilter — (Array<String>)

    A filter for the AZ IDs (use1-az1) of the Outpost.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Outposts — (Array<map>)

      Information about the Outposts.

      • OutpostId — (String)

        The ID of the Outpost.

      • OwnerId — (String)

        The AWS account ID of the Outpost owner.

      • OutpostArn — (String)

        The Amazon Resource Name (ARN) of the Outpost.

      • SiteId — (String)

        The ID of the site.

      • Name — (String)

        The name of the Outpost.

      • Description — (String)

        The description of the Outpost.

      • LifeCycleStatus — (String)

        The life cycle status.

      • AvailabilityZone — (String)

        The Availability Zone.

      • AvailabilityZoneId — (String)

        The ID of the Availability Zone.

      • Tags — (map<String>)

        The Outpost tags.

      • SiteArn — (String)

        The Amazon Resource Name (ARN) of the site.

    • NextToken — (String)

      The pagination token.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Lists the sites for the specified AWS account.

Service Reference:

• ListSites

Examples:

Calling the listSites operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
outposts.listSites(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    The pagination token.

  • MaxResults — (Integer)

    The maximum page size.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Sites — (Array<map>)

      Information about the sites.

      • SiteId — (String)

        The ID of the site.

      • AccountId — (String)

        The ID of the AWS account.

      • Name — (String)

        The name of the site.

      • Description — (String)

        The description of the site.

      • Tags — (map<String>)

        The site tags.

      • SiteArn — (String)

        The Amazon Resource Name (ARN) of the site.

    • NextToken — (String)

      The pagination token.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Lists the tags for the specified resource.

Service Reference:

• ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
outposts.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      The resource tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Adds tags to the specified resource.

Service Reference:

• TagResource

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
outposts.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • Tags — (map<String>)

    The tags to add to the resource.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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

Removes tags from the specified resource.

Service Reference:

• UntagResource

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
outposts.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys — (Array<String>)

    The tag keys.

Callback (callback):

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

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.