We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.S3Outposts

Inherits:
AWS.Service show all
Identifier:
s3outposts
API Version:
2017-07-25
Defined in:
(unknown)

Overview

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

Service Description

Amazon S3 on Outposts provides access to S3 on Outposts operations.

Sending a Request Using S3Outposts

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

var s3outposts = new AWS.S3Outposts({apiVersion: '2017-07-25'});

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

AWS.config.apiVersions = {
  s3outposts: '2017-07-25',
  // other service API versions
};

var s3outposts = new AWS.S3Outposts();

Version:

  • 2017-07-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a S3Outposts object

var s3outposts = new AWS.S3Outposts({apiVersion: '2017-07-25'});

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.S3Outposts.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.S3Outposts.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'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Creates an endpoint and associates it with the specified Outpost.

Note: It can take up to 5 minutes for this action to finish.

Related actions include:

Service Reference:

Examples:

Calling the createEndpoint operation

var params = {
  OutpostId: 'STRING_VALUE', /* required */
  SecurityGroupId: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  AccessType: Private | CustomerOwnedIp,
  CustomerOwnedIpv4Pool: 'STRING_VALUE'
};
s3outposts.createEndpoint(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 Outposts.

    • SubnetId — (String)

      The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

    • SecurityGroupId — (String)

      The ID of the security group to use with the endpoint.

    • AccessType — (String)

      The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

      Note: Private is the default access type value.
      Possible values include:
      • "Private"
      • "CustomerOwnedIp"
    • CustomerOwnedIpv4Pool — (String)

      The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

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:

      • EndpointArn — (String)

        The Amazon Resource Name (ARN) of the endpoint.

Returns:

  • (AWS.Request) —

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

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

Deletes an endpoint.

Note: It can take up to 5 minutes for this action to finish.

Related actions include:

Service Reference:

Examples:

Calling the deleteEndpoint operation

var params = {
  EndpointId: 'STRING_VALUE', /* required */
  OutpostId: 'STRING_VALUE' /* required */
};
s3outposts.deleteEndpoint(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: {}) —
    • EndpointId — (String)

      The ID of the endpoint.

    • OutpostId — (String)

      The ID of the Outposts.

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.

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

Lists endpoints associated with the specified Outpost.

Related actions include:

Service Reference:

Examples:

Calling the listEndpoints operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3outposts.listEndpoints(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)

      If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of endpoints that will be returned in the response.

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:

      • Endpoints — (Array<map>)

        The list of endpoints associated with the specified Outpost.

        • EndpointArn — (String)

          The Amazon Resource Name (ARN) of the endpoint.

        • OutpostsId — (String)

          The ID of the Outposts.

        • CidrBlock — (String)

          The VPC CIDR committed by this endpoint.

        • Status — (String)

          The status of the endpoint.

          Possible values include:
          • "Pending"
          • "Available"
          • "Deleting"
          • "Create_Failed"
          • "Delete_Failed"
        • CreationTime — (Date)

          The time the endpoint was created.

        • NetworkInterfaces — (Array<map>)

          The network interface of the endpoint.

          • NetworkInterfaceId — (String)

            The ID for the network interface.

        • VpcId — (String)

          The ID of the VPC used for the endpoint.

        • SubnetId — (String)

          The ID of the subnet used for the endpoint.

        • SecurityGroupId — (String)

          The ID of the security group used for the endpoint.

        • AccessType — (String)

          The type of connectivity used to access the Amazon S3 on Outposts endpoint.

          Possible values include:
          • "Private"
          • "CustomerOwnedIp"
        • CustomerOwnedIpv4Pool — (String)

          The ID of the customer-owned IPv4 address pool used for the endpoint.

        • FailedReason — (map)

          The failure reason, if any, for a create or delete endpoint operation.

          • ErrorCode — (String)

            The failure code, if any, for a create or delete endpoint operation.

          • Message — (String)

            Additional error details describing the endpoint failure and recommended action.

      • NextToken — (String)

        If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

Returns:

  • (AWS.Request) —

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

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

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).

Service Reference:

Examples:

Calling the listOutpostsWithS3 operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3outposts.listOutpostsWithS3(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)

      When you can get additional results from the ListOutpostsWithS3 call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional Outposts.

    • MaxResults — (Integer)

      The maximum number of Outposts to return. The limit is 100.

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>)

        Returns the list of Outposts that have the following characteristics:

        • outposts that have S3 provisioned

        • outposts that are Active (not pending any provisioning nor decommissioned)

        • outposts to which the the calling Amazon Web Services account has access

        • OutpostArn — (String)

          Specifies the unique Amazon Resource Name (ARN) for the outpost.

        • S3OutpostArn — (String)

          Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).

        • OutpostId — (String)

          Specifies the unique identifier for the outpost.

        • OwnerId — (String)

          Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.

        • CapacityInBytes — (Integer)

          The Amazon S3 capacity of the outpost in bytes.

      • NextToken — (String)

        Returns a token that you can use to call ListOutpostsWithS3 again and receive additional results, if there are any.

Returns:

  • (AWS.Request) —

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

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

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

Related actions include:

Service Reference:

Examples:

Calling the listSharedEndpoints operation

var params = {
  OutpostId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3outposts.listSharedEndpoints(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)

      If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of endpoints that will be returned in the response.

    • OutpostId — (String)

      The ID of the Amazon Web Services 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:

      • Endpoints — (Array<map>)

        The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

        • EndpointArn — (String)

          The Amazon Resource Name (ARN) of the endpoint.

        • OutpostsId — (String)

          The ID of the Outposts.

        • CidrBlock — (String)

          The VPC CIDR committed by this endpoint.

        • Status — (String)

          The status of the endpoint.

          Possible values include:
          • "Pending"
          • "Available"
          • "Deleting"
          • "Create_Failed"
          • "Delete_Failed"
        • CreationTime — (Date)

          The time the endpoint was created.

        • NetworkInterfaces — (Array<map>)

          The network interface of the endpoint.

          • NetworkInterfaceId — (String)

            The ID for the network interface.

        • VpcId — (String)

          The ID of the VPC used for the endpoint.

        • SubnetId — (String)

          The ID of the subnet used for the endpoint.

        • SecurityGroupId — (String)

          The ID of the security group used for the endpoint.

        • AccessType — (String)

          The type of connectivity used to access the Amazon S3 on Outposts endpoint.

          Possible values include:
          • "Private"
          • "CustomerOwnedIp"
        • CustomerOwnedIpv4Pool — (String)

          The ID of the customer-owned IPv4 address pool used for the endpoint.

        • FailedReason — (map)

          The failure reason, if any, for a create or delete endpoint operation.

          • ErrorCode — (String)

            The failure code, if any, for a create or delete endpoint operation.

          • Message — (String)

            Additional error details describing the endpoint failure and recommended action.

      • NextToken — (String)

        If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

Returns:

  • (AWS.Request) —

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