Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

Class: AWS.S3Control

Inherits:
AWS.Service show all
Identifier:
s3control
API Version:
2018-08-20
Defined in:
(unknown)

Overview

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

Service Description

AWS S3 Control provides access to Amazon S3 control plane actions.

Sending a Request Using S3Control

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

var s3control = new AWS.S3Control({apiVersion: '2018-08-20'});

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

AWS.config.apiVersions = {
  s3control: '2018-08-20',
  // other service API versions
};

var s3control = new AWS.S3Control();

Version:

  • 2018-08-20

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

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

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

Examples:

Constructing a S3Control object

var s3control = new AWS.S3Control({apiVersion: '2018-08-20'});

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.

  • useDualstack (Boolean) —

    Enables IPv6/IPv4 dualstack endpoint. When a DNS lookup is performed on an endpoint of this type, it returns an “A” record with an IPv4 address and an “AAAA” record with an IPv6 address. In most cases the network stack in the client environment will automatically prefer the AAAA record and make a connection using the IPv6 address. Note, however, that currently on Windows, the IPv4 address will be preferred.

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

addOutpostIdHeader(req) ⇒ void

Adds outpostId header

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

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

Note: S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

Service Reference:

Examples:

Calling the createAccessPoint operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  PublicAccessBlockConfiguration: {
    BlockPublicAcls: true || false,
    BlockPublicPolicy: true || false,
    IgnorePublicAcls: true || false,
    RestrictPublicBuckets: true || false
  },
  VpcConfiguration: {
    VpcId: 'STRING_VALUE' /* required */
  }
};
s3control.createAccessPoint(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: {}) —
    • AccountId — (String)

      The AWS account ID for the owner of the bucket for which you want to create an access point.

    • Name — (String)

      The name you want to assign to this access point.

    • Bucket — (String)

      The name of the bucket that you want to associate this access point with.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    • VpcConfiguration — (map)

      If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

      Note: This is required for creating an access point for Amazon S3 on Outposts buckets.
      • VpcId — required — (String)

        If this field is specified, this access point will only allow connections from the specified VPC ID.

    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration that you want to apply to the access point.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn't affect existing bucket policies.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

        Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

        This is not supported for Amazon S3 on 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. The data object has the following properties:

      • AccessPointArn — (String)

        The ARN of the access point.

        Note: This is only supported by Amazon S3 on Outposts.

Returns:

  • (AWS.Request) —

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

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

Creates an Object Lambda Access Point. For more information, see Transforming objects with Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to CreateAccessPointForObjectLambda:

Service Reference:

Examples:

Calling the createAccessPointForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Configuration: { /* required */
    SupportingAccessPoint: 'STRING_VALUE', /* required */
    TransformationConfigurations: [ /* required */
      {
        Actions: [ /* required */
          GetObject,
          /* more items */
        ],
        ContentTransformation: { /* required */
          AwsLambda: {
            FunctionArn: 'STRING_VALUE', /* required */
            FunctionPayload: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ],
    AllowedFeatures: [
      GetObject-Range | GetObject-PartNumber,
      /* more items */
    ],
    CloudWatchMetricsEnabled: true || false
  },
  Name: 'STRING_VALUE' /* required */
};
s3control.createAccessPointForObjectLambda(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: {}) —
    • AccountId — (String)

      The AWS account ID for owner of the specified Object Lambda Access Point.

    • Name — (String)

      The name you want to assign to this Object Lambda Access Point.

    • Configuration — (map)

      Object Lambda Access Point configuration as a JSON document.

      • SupportingAccessPoint — required — (String)

        Standard access point associated with the Object Lambda Access Point.

      • CloudWatchMetricsEnabled — (Boolean)

        A container for whether the CloudWatch metrics configuration is enabled.

      • AllowedFeatures — (Array<String>)

        A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

      • TransformationConfigurations — required — (Array<map>)

        A container for transformation configurations for an Object Lambda Access Point.

        • Actions — required — (Array<String>)

          A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

        • ContentTransformation — required — (map)

          A container for the content transformation of an Object Lambda Access Point configuration.

          • AwsLambda — (map)

            A container for an AWS Lambda function.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the AWS Lambda function.

            • FunctionPayload — (String)

              Additional JSON that provides supplemental data to the Lambda function used to transform objects.

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:

      • ObjectLambdaAccessPointArn — (String)

        Specifies the ARN for the Object Lambda Access Point.

Returns:

  • (AWS.Request) —

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

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

Note: This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see Create Bucket in the Amazon S3 API Reference.

Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.

S3 on Outposts buckets support:

  • Tags

  • LifecycleConfigurations for deleting expired objects

For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see Amazon S3 on Outposts Restrictions and Limitations.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your API request, see the Examples section.

The following actions are related to CreateBucket for Amazon S3 on Outposts:

Service Reference:

Examples:

Calling the createBucket operation

var params = {
  Bucket: 'STRING_VALUE', /* required */
  ACL: private | public-read | public-read-write | authenticated-read,
  CreateBucketConfiguration: {
    LocationConstraint: EU | eu-west-1 | us-west-1 | us-west-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1 | cn-north-1 | eu-central-1
  },
  GrantFullControl: 'STRING_VALUE',
  GrantRead: 'STRING_VALUE',
  GrantReadACP: 'STRING_VALUE',
  GrantWrite: 'STRING_VALUE',
  GrantWriteACP: 'STRING_VALUE',
  ObjectLockEnabledForBucket: true || false,
  OutpostId: 'STRING_VALUE'
};
s3control.createBucket(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: {}) —
    • ACL — (String)

      The canned ACL to apply to the bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
    • Bucket — (String)

      The name of the bucket.

    • CreateBucketConfiguration — (map)

      The configuration information for the bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
      • LocationConstraint — (String)

        Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.

        Note: This is not supported by Amazon S3 on Outposts buckets.
        Possible values include:
        • "EU"
        • "eu-west-1"
        • "us-west-1"
        • "us-west-2"
        • "ap-south-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-northeast-1"
        • "sa-east-1"
        • "cn-north-1"
        • "eu-central-1"
    • GrantFullControl — (String)

      Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • GrantRead — (String)

      Allows grantee to list the objects in the bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • GrantReadACP — (String)

      Allows grantee to read the bucket ACL.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • GrantWrite — (String)

      Allows grantee to create, overwrite, and delete any object in the bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • GrantWriteACP — (String)

      Allows grantee to write the ACL for the applicable bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • ObjectLockEnabledForBucket — (Boolean)

      Specifies whether you want S3 Object Lock to be enabled for the new bucket.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • OutpostId — (String)

      The ID of the Outposts where the bucket is being created.

      Note: This is required by Amazon S3 on Outposts buckets.

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:

      • Location — (String)

        The location of the bucket.

      • BucketArn — (String)

        The Amazon Resource Name (ARN) of the bucket.

        For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

        For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Returns:

  • (AWS.Request) —

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

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

You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

This action creates a S3 Batch Operations job.

Related actions include:

Service Reference:

Examples:

Calling the createJob operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE', /* required */
  Manifest: { /* required */
    Location: { /* required */
      ETag: 'STRING_VALUE', /* required */
      ObjectArn: 'STRING_VALUE', /* required */
      ObjectVersionId: 'STRING_VALUE'
    },
    Spec: { /* required */
      Format: S3BatchOperations_CSV_20180820 | S3InventoryReport_CSV_20161130, /* required */
      Fields: [
        Ignore | Bucket | Key | VersionId,
        /* more items */
      ]
    }
  },
  Operation: { /* required */
    LambdaInvoke: {
      FunctionArn: 'STRING_VALUE'
    },
    S3DeleteObjectTagging: {
    },
    S3InitiateRestoreObject: {
      ExpirationInDays: 'NUMBER_VALUE',
      GlacierJobTier: BULK | STANDARD
    },
    S3PutObjectAcl: {
      AccessControlPolicy: {
        AccessControlList: {
          Owner: { /* required */
            DisplayName: 'STRING_VALUE',
            ID: 'STRING_VALUE'
          },
          Grants: [
            {
              Grantee: {
                DisplayName: 'STRING_VALUE',
                Identifier: 'STRING_VALUE',
                TypeIdentifier: id | emailAddress | uri
              },
              Permission: FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP
            },
            /* more items */
          ]
        },
        CannedAccessControlList: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control
      }
    },
    S3PutObjectCopy: {
      AccessControlGrants: [
        {
          Grantee: {
            DisplayName: 'STRING_VALUE',
            Identifier: 'STRING_VALUE',
            TypeIdentifier: id | emailAddress | uri
          },
          Permission: FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP
        },
        /* more items */
      ],
      BucketKeyEnabled: true || false,
      CannedAccessControlList: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control,
      MetadataDirective: COPY | REPLACE,
      ModifiedSinceConstraint: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      NewObjectMetadata: {
        CacheControl: 'STRING_VALUE',
        ContentDisposition: 'STRING_VALUE',
        ContentEncoding: 'STRING_VALUE',
        ContentLanguage: 'STRING_VALUE',
        ContentLength: 'NUMBER_VALUE',
        ContentMD5: 'STRING_VALUE',
        ContentType: 'STRING_VALUE',
        HttpExpiresDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        RequesterCharged: true || false,
        SSEAlgorithm: AES256 | KMS,
        UserMetadata: {
          '<NonEmptyMaxLength1024String>': 'STRING_VALUE',
          /* '<NonEmptyMaxLength1024String>': ... */
        }
      },
      NewObjectTagging: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      ObjectLockLegalHoldStatus: OFF | ON,
      ObjectLockMode: COMPLIANCE | GOVERNANCE,
      ObjectLockRetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      RedirectLocation: 'STRING_VALUE',
      RequesterPays: true || false,
      SSEAwsKmsKeyId: 'STRING_VALUE',
      StorageClass: STANDARD | STANDARD_IA | ONEZONE_IA | GLACIER | INTELLIGENT_TIERING | DEEP_ARCHIVE,
      TargetKeyPrefix: 'STRING_VALUE',
      TargetResource: 'STRING_VALUE',
      UnModifiedSinceConstraint: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    S3PutObjectLegalHold: {
      LegalHold: { /* required */
        Status: OFF | ON /* required */
      }
    },
    S3PutObjectRetention: {
      Retention: { /* required */
        Mode: COMPLIANCE | GOVERNANCE,
        RetainUntilDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      BypassGovernanceRetention: true || false
    },
    S3PutObjectTagging: {
      TagSet: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  Priority: 'NUMBER_VALUE', /* required */
  Report: { /* required */
    Enabled: true || false, /* required */
    Bucket: 'STRING_VALUE',
    Format: Report_CSV_20180820,
    Prefix: 'STRING_VALUE',
    ReportScope: AllTasks | FailedTasksOnly
  },
  RoleArn: 'STRING_VALUE', /* required */
  ConfirmationRequired: true || false,
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.createJob(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: {}) —
    • AccountId — (String)

      The AWS account ID that creates the job.

    • ConfirmationRequired — (Boolean)

      Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    • Operation — (map)

      The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

      • LambdaInvoke — (map)

        Directs the specified job to invoke an AWS Lambda function on every object in the manifest.

        • FunctionArn — (String)

          The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.

      • S3PutObjectCopy — (map)

        Directs the specified job to run a PUT Copy object call on every object in the manifest.

        • TargetResource — (String)

          Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".

        • CannedAccessControlList — (String)

          Possible values include:

          • "private"
          • "public-read"
          • "public-read-write"
          • "aws-exec-read"
          • "authenticated-read"
          • "bucket-owner-read"
          • "bucket-owner-full-control"
        • AccessControlGrants — (Array<map>)

          • Grantee — (map)

            • TypeIdentifier — (String)

              Possible values include:

              • "id"
              • "emailAddress"
              • "uri"
            • Identifier — (String)

            • DisplayName — (String)

          • Permission — (String)

            Possible values include:

            • "FULL_CONTROL"
            • "READ"
            • "WRITE"
            • "READ_ACP"
            • "WRITE_ACP"
        • MetadataDirective — (String)

          Possible values include:

          • "COPY"
          • "REPLACE"
        • ModifiedSinceConstraint — (Date)

        • NewObjectMetadata — (map)

          • CacheControl — (String)

          • ContentDisposition — (String)

          • ContentEncoding — (String)

          • ContentLanguage — (String)

          • UserMetadata — (map<String>)

          • ContentLength — (Integer)

          • ContentMD5 — (String)

          • ContentType — (String)

          • HttpExpiresDate — (Date)

          • RequesterCharged — (Boolean)

          • SSEAlgorithm — (String)

            Possible values include:

            • "AES256"
            • "KMS"
        • NewObjectTagging — (Array<map>)

          • Key — required — (String)

          • Value — required — (String)

        • RedirectLocation — (String)

          Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

        • RequesterPays — (Boolean)

        • StorageClass — (String)

          Possible values include:

          • "STANDARD"
          • "STANDARD_IA"
          • "ONEZONE_IA"
          • "GLACIER"
          • "INTELLIGENT_TIERING"
          • "DEEP_ARCHIVE"
        • UnModifiedSinceConstraint — (Date)

        • SSEAwsKmsKeyId — (String)

        • TargetKeyPrefix — (String)

          Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".

        • ObjectLockLegalHoldStatus — (String)

          The legal hold status to be applied to all objects in the Batch Operations job.

          Possible values include:
          • "OFF"
          • "ON"
        • ObjectLockMode — (String)

          The retention mode to be applied to all objects in the Batch Operations job.

          Possible values include:
          • "COMPLIANCE"
          • "GOVERNANCE"
        • ObjectLockRetainUntilDate — (Date)

          The date when the applied object retention configuration expires on all objects in the Batch Operations job.

        • BucketKeyEnabled — (Boolean)

          Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

          Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

      • S3PutObjectAcl — (map)

        Directs the specified job to run a PUT Object acl call on every object in the manifest.

        • AccessControlPolicy — (map)

          • AccessControlList — (map)

            • Owner — required — (map)

              • ID — (String)

              • DisplayName — (String)

            • Grants — (Array<map>)

              • Grantee — (map)

                • TypeIdentifier — (String)

                  Possible values include:

                  • "id"
                  • "emailAddress"
                  • "uri"
                • Identifier — (String)

                • DisplayName — (String)

              • Permission — (String)

                Possible values include:

                • "FULL_CONTROL"
                • "READ"
                • "WRITE"
                • "READ_ACP"
                • "WRITE_ACP"
          • CannedAccessControlList — (String)

            Possible values include:

            • "private"
            • "public-read"
            • "public-read-write"
            • "aws-exec-read"
            • "authenticated-read"
            • "bucket-owner-read"
            • "bucket-owner-full-control"
      • S3PutObjectTagging — (map)

        Directs the specified job to run a PUT Object tagging call on every object in the manifest.

        • TagSet — (Array<map>)

          • Key — required — (String)

          • Value — required — (String)

      • S3DeleteObjectTagging — (map)

        Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

      • S3InitiateRestoreObject — (map)

        Directs the specified job to initiate restore requests for every archived object in the manifest.

        • ExpirationInDays — (Integer)

          This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

          Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

          S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

        • GlacierJobTier — (String)

          S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

          Possible values include:
          • "BULK"
          • "STANDARD"
      • S3PutObjectLegalHold — (map)

        Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

        • LegalHold — required — (map)

          Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

          • Status — required — (String)

            The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

            Possible values include:
            • "OFF"
            • "ON"
      • S3PutObjectRetention — (map)

        Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

        • BypassGovernanceRetention — (Boolean)

          Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

        • Retention — required — (map)

          Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

          • RetainUntilDate — (Date)

            The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

          • Mode — (String)

            The Object Lock retention mode to be applied to all objects in the Batch Operations job.

            Possible values include:
            • "COMPLIANCE"
            • "GOVERNANCE"
    • Report — (map)

      Configuration parameters for the optional job-completion report.

      • Bucket — (String)

        The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

      • Format — (String)

        The format of the specified job-completion report.

        Possible values include:
        • "Report_CSV_20180820"
      • Enabled — required — (Boolean)

        Indicates whether the specified job will generate a job-completion report.

      • Prefix — (String)

        An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

      • ReportScope — (String)

        Indicates whether the job-completion report will include details of all tasks or only failed tasks.

        Possible values include:
        • "AllTasks"
        • "FailedTasksOnly"
    • ClientRequestToken — (String)

      An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Manifest — (map)

      Configuration parameters for the manifest.

      • Spec — required — (map)

        Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

        • Format — required — (String)

          Indicates which of the available formats the specified manifest uses.

          Possible values include:
          • "S3BatchOperations_CSV_20180820"
          • "S3InventoryReport_CSV_20161130"
        • Fields — (Array<String>)

          If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

      • Location — required — (map)

        Contains the information required to locate the specified job's manifest.

        • ObjectArn — required — (String)

          The Amazon Resource Name (ARN) for a manifest object.

          Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

        • ObjectVersionId — (String)

          The optional version ID to identify a specific version of the manifest object.

        • ETag — required — (String)

          The ETag for the specified manifest object.

    • Description — (String)

      A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

    • Priority — (Integer)

      The numerical priority for this job. Higher numbers indicate higher priority.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

    • Tags — (Array<map>)

      A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

      • Key — required — (String)

      • Value — required — (String)

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:

      • JobId — (String)

        The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

Service Reference:

Examples:

Calling the deleteAccessPoint operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPoint(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified access point.

    • Name — (String)

      The name of the access point you want to delete.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

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.

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

Deletes the specified Object Lambda Access Point.

The following actions are related to DeleteAccessPointForObjectLambda:

Service Reference:

Examples:

Calling the deleteAccessPointForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the access point you want to delete.

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.

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

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

Service Reference:

Examples:

Calling the deleteAccessPointPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointPolicy(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified access point.

    • Name — (String)

      The name of the access point whose policy you want to delete.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

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.

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

Removes the resource policy for an Object Lambda Access Point.

The following actions are related to DeleteAccessPointPolicyForObjectLambda:

Service Reference:

Examples:

Calling the deleteAccessPointPolicyForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.deleteAccessPointPolicyForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point you want to delete the policy for.

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.

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

Note: This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

Related Resources

Service Reference:

Examples:

Calling the deleteBucket operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucket(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: {}) —
    • AccountId — (String)

      The account ID that owns the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket being deleted.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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.

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

Note: This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

Service Reference:

Examples:

Calling the deleteBucketLifecycleConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketLifecycleConfiguration(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: {}) —
    • AccountId — (String)

      The account ID of the lifecycle configuration to delete.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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.

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

Note: This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

Service Reference:

Examples:

Calling the deleteBucketPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketPolicy(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: {}) —
    • AccountId — (String)

      The account ID of the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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.

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

Note: This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

Service Reference:

Examples:

Calling the deleteBucketTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.deleteBucketTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket tag set to be removed.

    • Bucket — (String)

      The bucket ARN that has the tag set to be removed.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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.

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

Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the deleteJobTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.deleteJobTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID for the S3 Batch Operations job whose tags you want to delete.

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.

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

Removes the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.

Related actions include:

Service Reference:

Examples:

Calling the deletePublicAccessBlock operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
s3control.deletePublicAccessBlock(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: {}) —
    • AccountId — (String)

      The account ID for the AWS account whose PublicAccessBlock configuration you want to remove.

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.

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

Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:DeleteStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the deleteStorageLensConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.deleteStorageLensConfiguration(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: {}) —
    • ConfigId — (String)

      The ID of the S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

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.

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

Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:DeleteStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the deleteStorageLensConfigurationTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.deleteStorageLensConfigurationTagging(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: {}) —
    • ConfigId — (String)

      The ID of the S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

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.

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

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the describeJob operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.describeJob(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID for the job whose information you want to retrieve.

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:

      • Job — (map)

        Contains the configuration parameters and status for the job specified in the Describe Job request.

        • JobId — (String)

          The ID for the specified job.

        • ConfirmationRequired — (Boolean)

          Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

        • Description — (String)

          The description for this job, if one was provided in this job's Create Job request.

        • JobArn — (String)

          The Amazon Resource Name (ARN) for this job.

        • Status — (String)

          The current status of the specified job.

          Possible values include:
          • "Active"
          • "Cancelled"
          • "Cancelling"
          • "Complete"
          • "Completing"
          • "Failed"
          • "Failing"
          • "New"
          • "Paused"
          • "Pausing"
          • "Preparing"
          • "Ready"
          • "Suspended"
        • Manifest — (map)

          The configuration information for the specified job's manifest object.

          • Spec — required — (map)

            Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

            • Format — required — (String)

              Indicates which of the available formats the specified manifest uses.

              Possible values include:
              • "S3BatchOperations_CSV_20180820"
              • "S3InventoryReport_CSV_20161130"
            • Fields — (Array<String>)

              If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

          • Location — required — (map)

            Contains the information required to locate the specified job's manifest.

            • ObjectArn — required — (String)

              The Amazon Resource Name (ARN) for a manifest object.

              Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

            • ObjectVersionId — (String)

              The optional version ID to identify a specific version of the manifest object.

            • ETag — required — (String)

              The ETag for the specified manifest object.

        • Operation — (map)

          The operation that the specified job is configured to run on the objects listed in the manifest.

          • LambdaInvoke — (map)

            Directs the specified job to invoke an AWS Lambda function on every object in the manifest.

            • FunctionArn — (String)

              The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke on every object in the manifest.

          • S3PutObjectCopy — (map)

            Directs the specified job to run a PUT Copy object call on every object in the manifest.

            • TargetResource — (String)

              Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".

            • CannedAccessControlList — (String)

              Possible values include:

              • "private"
              • "public-read"
              • "public-read-write"
              • "aws-exec-read"
              • "authenticated-read"
              • "bucket-owner-read"
              • "bucket-owner-full-control"
            • AccessControlGrants — (Array<map>)

              • Grantee — (map)

                • TypeIdentifier — (String)

                  Possible values include:

                  • "id"
                  • "emailAddress"
                  • "uri"
                • Identifier — (String)

                • DisplayName — (String)

              • Permission — (String)

                Possible values include:

                • "FULL_CONTROL"
                • "READ"
                • "WRITE"
                • "READ_ACP"
                • "WRITE_ACP"
            • MetadataDirective — (String)

              Possible values include:

              • "COPY"
              • "REPLACE"
            • ModifiedSinceConstraint — (Date)

            • NewObjectMetadata — (map)

              • CacheControl — (String)

              • ContentDisposition — (String)

              • ContentEncoding — (String)

              • ContentLanguage — (String)

              • UserMetadata — (map<String>)

              • ContentLength — (Integer)

              • ContentMD5 — (String)

              • ContentType — (String)

              • HttpExpiresDate — (Date)

              • RequesterCharged — (Boolean)

              • SSEAlgorithm — (String)

                Possible values include:

                • "AES256"
                • "KMS"
            • NewObjectTagging — (Array<map>)

              • Key — required — (String)

              • Value — required — (String)

            • RedirectLocation — (String)

              Specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object is accessed through a website endpoint.

            • RequesterPays — (Boolean)

            • StorageClass — (String)

              Possible values include:

              • "STANDARD"
              • "STANDARD_IA"
              • "ONEZONE_IA"
              • "GLACIER"
              • "INTELLIGENT_TIERING"
              • "DEEP_ARCHIVE"
            • UnModifiedSinceConstraint — (Date)

            • SSEAwsKmsKeyId — (String)

            • TargetKeyPrefix — (String)

              Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".

            • ObjectLockLegalHoldStatus — (String)

              The legal hold status to be applied to all objects in the Batch Operations job.

              Possible values include:
              • "OFF"
              • "ON"
            • ObjectLockMode — (String)

              The retention mode to be applied to all objects in the Batch Operations job.

              Possible values include:
              • "COMPLIANCE"
              • "GOVERNANCE"
            • ObjectLockRetainUntilDate — (Date)

              The date when the applied object retention configuration expires on all objects in the Batch Operations job.

            • BucketKeyEnabled — (Boolean)

              Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

              Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

          • S3PutObjectAcl — (map)

            Directs the specified job to run a PUT Object acl call on every object in the manifest.

            • AccessControlPolicy — (map)

              • AccessControlList — (map)

                • Owner — required — (map)

                  • ID — (String)

                  • DisplayName — (String)

                • Grants — (Array<map>)

                  • Grantee — (map)

                    • TypeIdentifier — (String)

                      Possible values include:

                      • "id"
                      • "emailAddress"
                      • "uri"
                    • Identifier — (String)

                    • DisplayName — (String)

                  • Permission — (String)

                    Possible values include:

                    • "FULL_CONTROL"
                    • "READ"
                    • "WRITE"
                    • "READ_ACP"
                    • "WRITE_ACP"
              • CannedAccessControlList — (String)

                Possible values include:

                • "private"
                • "public-read"
                • "public-read-write"
                • "aws-exec-read"
                • "authenticated-read"
                • "bucket-owner-read"
                • "bucket-owner-full-control"
          • S3PutObjectTagging — (map)

            Directs the specified job to run a PUT Object tagging call on every object in the manifest.

            • TagSet — (Array<map>)

              • Key — required — (String)

              • Value — required — (String)

          • S3DeleteObjectTagging — (map)

            Directs the specified job to execute a DELETE Object tagging call on every object in the manifest.

          • S3InitiateRestoreObject — (map)

            Directs the specified job to initiate restore requests for every archived object in the manifest.

            • ExpirationInDays — (Integer)

              This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

              Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

              S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

            • GlacierJobTier — (String)

              S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

              Possible values include:
              • "BULK"
              • "STANDARD"
          • S3PutObjectLegalHold — (map)

            Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

            • LegalHold — required — (map)

              Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

              • Status — required — (String)

                The Object Lock legal hold status to be applied to all objects in the Batch Operations job.

                Possible values include:
                • "OFF"
                • "ON"
          • S3PutObjectRetention — (map)

            Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

            • BypassGovernanceRetention — (Boolean)

              Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

            • Retention — required — (map)

              Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

              • RetainUntilDate — (Date)

                The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

              • Mode — (String)

                The Object Lock retention mode to be applied to all objects in the Batch Operations job.

                Possible values include:
                • "COMPLIANCE"
                • "GOVERNANCE"
        • Priority — (Integer)

          The priority of the specified job.

        • ProgressSummary — (map)

          Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

          • TotalNumberOfTasks — (Integer)

          • NumberOfTasksSucceeded — (Integer)

          • NumberOfTasksFailed — (Integer)

        • StatusUpdateReason — (String)

          The reason for updating the job.

        • FailureReasons — (Array<map>)

          If the specified job failed, this field contains information describing the failure.

          • FailureCode — (String)

            The failure code, if any, for the specified job.

          • FailureReason — (String)

            The failure reason, if any, for the specified job.

        • Report — (map)

          Contains the configuration information for the job-completion report if you requested one in the Create Job request.

          • Bucket — (String)

            The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

          • Format — (String)

            The format of the specified job-completion report.

            Possible values include:
            • "Report_CSV_20180820"
          • Enabled — required — (Boolean)

            Indicates whether the specified job will generate a job-completion report.

          • Prefix — (String)

            An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

          • ReportScope — (String)

            Indicates whether the job-completion report will include details of all tasks or only failed tasks.

            Possible values include:
            • "AllTasks"
            • "FailedTasksOnly"
        • CreationTime — (Date)

          A timestamp indicating when this job was created.

        • TerminationDate — (Date)

          A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

        • SuspendedDate — (Date)

          The timestamp when this job was suspended, if it has been suspended.

        • SuspendedCause — (String)

          The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Returns:

  • (AWS.Request) —

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

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

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

Service Reference:

Examples:

Calling the getAccessPoint operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPoint(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified access point.

    • Name — (String)

      The name of the access point whose configuration information you want to retrieve.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

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:

      • Name — (String)

        The name of the specified access point.

      • Bucket — (String)

        The name of the bucket associated with the specified access point.

      • NetworkOrigin — (String)

        Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

        This will always be true for an Amazon S3 on Outposts access point

        Possible values include:
        • "Internet"
        • "VPC"
      • VpcConfiguration — (map)

        Contains the virtual private cloud (VPC) configuration for the specified access point.

        Note: This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other AWS services.
        • VpcId — required — (String)

          If this field is specified, this access point will only allow connections from the specified VPC ID.

      • PublicAccessBlockConfiguration — (map)

        The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

        This is not supported for Amazon S3 on Outposts.

        • BlockPublicAcls — (Boolean)

          Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

          • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

          • PUT Object calls fail if the request includes a public ACL.

          • PUT Bucket calls fail if the request includes a public ACL.

          Enabling this setting doesn't affect existing policies or ACLs.

          This is not supported for Amazon S3 on Outposts.

        • IgnorePublicAcls — (Boolean)

          Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

          Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

          This is not supported for Amazon S3 on Outposts.

        • BlockPublicPolicy — (Boolean)

          Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

          Enabling this setting doesn't affect existing bucket policies.

          This is not supported for Amazon S3 on Outposts.

        • RestrictPublicBuckets — (Boolean)

          Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

          Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

          This is not supported for Amazon S3 on Outposts.

      • CreationDate — (Date)

        The date and time when the specified access point was created.

Returns:

  • (AWS.Request) —

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

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

Returns configuration for an Object Lambda Access Point.

The following actions are related to GetAccessPointConfigurationForObjectLambda:

Service Reference:

Examples:

Calling the getAccessPointConfigurationForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointConfigurationForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point you want to return the configuration for.

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:

      • Configuration — (map)

        Object Lambda Access Point configuration document.

        • SupportingAccessPoint — required — (String)

          Standard access point associated with the Object Lambda Access Point.

        • CloudWatchMetricsEnabled — (Boolean)

          A container for whether the CloudWatch metrics configuration is enabled.

        • AllowedFeatures — (Array<String>)

          A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

        • TransformationConfigurations — required — (Array<map>)

          A container for transformation configurations for an Object Lambda Access Point.

          • Actions — required — (Array<String>)

            A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

          • ContentTransformation — required — (map)

            A container for the content transformation of an Object Lambda Access Point configuration.

            • AwsLambda — (map)

              A container for an AWS Lambda function.

              • FunctionArn — required — (String)

                The Amazon Resource Name (ARN) of the AWS Lambda function.

              • FunctionPayload — (String)

                Additional JSON that provides supplemental data to the Lambda function used to transform objects.

Returns:

  • (AWS.Request) —

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

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

Returns configuration information about the specified Object Lambda Access Point

The following actions are related to GetAccessPointForObjectLambda:

Service Reference:

Examples:

Calling the getAccessPointForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point.

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:

      • Name — (String)

        The name of the Object Lambda Access Point.

      • PublicAccessBlockConfiguration — (map)

        Configuration to block all public access. This setting is turned on and can not be edited.

        • BlockPublicAcls — (Boolean)

          Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

          • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

          • PUT Object calls fail if the request includes a public ACL.

          • PUT Bucket calls fail if the request includes a public ACL.

          Enabling this setting doesn't affect existing policies or ACLs.

          This is not supported for Amazon S3 on Outposts.

        • IgnorePublicAcls — (Boolean)

          Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

          Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

          This is not supported for Amazon S3 on Outposts.

        • BlockPublicPolicy — (Boolean)

          Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

          Enabling this setting doesn't affect existing bucket policies.

          This is not supported for Amazon S3 on Outposts.

        • RestrictPublicBuckets — (Boolean)

          Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

          Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

          This is not supported for Amazon S3 on Outposts.

      • CreationDate — (Date)

        The date and time when the specified Object Lambda Access Point was created.

Returns:

  • (AWS.Request) —

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

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

Returns the access point policy associated with the specified access point.

The following actions are related to GetAccessPointPolicy:

Service Reference:

Examples:

Calling the getAccessPointPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicy(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified access point.

    • Name — (String)

      The name of the access point whose policy you want to retrieve.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

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:

      • Policy — (String)

        The access point policy associated with the specified access point.

Returns:

  • (AWS.Request) —

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

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

Returns the resource policy for an Object Lambda Access Point.

The following actions are related to GetAccessPointPolicyForObjectLambda:

Service Reference:

Examples:

Calling the getAccessPointPolicyForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point.

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:

      • Policy — (String)

        Object Lambda Access Point resource policy document.

Returns:

  • (AWS.Request) —

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

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

Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 access points in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the getAccessPointPolicyStatus operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyStatus(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified access point.

    • Name — (String)

      The name of the access point whose policy status you want to retrieve.

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:

      • PolicyStatus — (map)

        Indicates the current policy status of the specified access point.

        • IsPublic — (Boolean)

Returns:

  • (AWS.Request) —

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

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

Returns the status of the resource policy associated with an Object Lambda Access Point.

Service Reference:

Examples:

Calling the getAccessPointPolicyStatusForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
s3control.getAccessPointPolicyStatusForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point.

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:

      • PolicyStatus — (map)

        Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of "Public" in the Amazon S3 User Guide.

        • IsPublic — (Boolean)

Returns:

  • (AWS.Request) —

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

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

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

The following actions are related to GetBucket for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

Service Reference:

Examples:

Calling the getBucket operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucket(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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:

      • Bucket — (String)

        The Outposts bucket requested.

      • PublicAccessBlockEnabled — (Boolean)

      • CreationDate — (Date)

        The creation date of the Outposts bucket.

Returns:

  • (AWS.Request) —

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

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

Note: This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

GetBucketLifecycleConfiguration has the following special error:

  • Error code: NoSuchLifecycleConfiguration

    • Description: The lifecycle configuration does not exist.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

The following actions are related to GetBucketLifecycleConfiguration:

Service Reference:

Examples:

Calling the getBucketLifecycleConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketLifecycleConfiguration(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      The Amazon Resource Name (ARN) of the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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:

      • Rules — (Array<map>)

        Container for the lifecycle rule of the Outposts bucket.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date — (Date)

            Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Filter — (map)

          The container for the filter of lifecycle rule.

          • Prefix — (String)

            Prefix identifying one or more objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            • Key — required — (String)

            • Value — required — (String)

          • And — (map)

            The container for the AND condition for the lifecycle rule.

            • Prefix — (String)

              Prefix identifying one or more objects to which the rule applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • Key — required — (String)

              • Value — required — (String)

        • Status — required — (String)

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transitions — (Array<map>)

          Specifies when an Amazon S3 object transitions to a specified storage class.

          Note: This is not supported by Amazon S3 on Outposts buckets.
          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransitions — (Array<map>)

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          Note: This is not supported by Amazon S3 on Outposts buckets.
          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          The noncurrent version expiration of the lifecycle rule.

          Note: This is not supported by Amazon S3 on Outposts buckets.
        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

Returns:

  • (AWS.Request) —

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

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

Note: This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

Service Reference:

Examples:

Calling the getBucketPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketPolicy(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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:

      • Policy — (String)

        The policy of the Outposts bucket.

Returns:

  • (AWS.Request) —

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

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

Note: This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

  • Error code: NoSuchTagSetError

    • Description: There is no tag set associated with the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

Service Reference:

Examples:

Calling the getBucketTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE' /* required */
};
s3control.getBucketTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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:

      • TagSet — (Array<map>)

        The tags set of the Outposts bucket.

        • Key — required — (String)

        • Value — required — (String)

Returns:

  • (AWS.Request) —

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

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

Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the getJobTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
s3control.getJobTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID for the S3 Batch Operations job whose tags you want to retrieve.

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 — (Array<map>)

        The set of tags associated with the S3 Batch Operations job.

        • Key — required — (String)

        • Value — required — (String)

Returns:

  • (AWS.Request) —

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

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

Retrieves the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.

Related actions include:

Service Reference:

Examples:

Calling the getPublicAccessBlock operation

var params = {
  AccountId: 'STRING_VALUE' /* required */
};
s3control.getPublicAccessBlock(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: {}) —
    • AccountId — (String)

      The account ID for the AWS account whose PublicAccessBlock configuration you want to retrieve.

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:

      • PublicAccessBlockConfiguration — (map)

        The PublicAccessBlock configuration currently in effect for this AWS account.

        • BlockPublicAcls — (Boolean)

          Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

          • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

          • PUT Object calls fail if the request includes a public ACL.

          • PUT Bucket calls fail if the request includes a public ACL.

          Enabling this setting doesn't affect existing policies or ACLs.

          This is not supported for Amazon S3 on Outposts.

        • IgnorePublicAcls — (Boolean)

          Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

          Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

          This is not supported for Amazon S3 on Outposts.

        • BlockPublicPolicy — (Boolean)

          Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

          Enabling this setting doesn't affect existing bucket policies.

          This is not supported for Amazon S3 on Outposts.

        • RestrictPublicBuckets — (Boolean)

          Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

          Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

          This is not supported for Amazon S3 on Outposts.

Returns:

  • (AWS.Request) —

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

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

Gets the Amazon S3 Storage Lens configuration. For more information, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:GetStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the getStorageLensConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.getStorageLensConfiguration(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: {}) —
    • ConfigId — (String)

      The ID of the Amazon S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

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:

      • StorageLensConfiguration — (map)

        The S3 Storage Lens configuration requested.

        • Id — required — (String)

          A container for the Amazon S3 Storage Lens configuration ID.

        • AccountLevel — required — (map)

          A container for all the account-level configurations of your S3 Storage Lens configuration.

          • ActivityMetrics — (map)

            A container for the S3 Storage Lens activity metrics.

            • IsEnabled — (Boolean)

              A container for whether the activity metrics are enabled.

          • BucketLevel — required — (map)

            A container for the S3 Storage Lens bucket-level configuration.

            • ActivityMetrics — (map)

              A container for the bucket-level activity metrics for Amazon S3 Storage Lens

              • IsEnabled — (Boolean)

                A container for whether the activity metrics are enabled.

            • PrefixLevel — (map)

              A container for the bucket-level prefix-level metrics for S3 Storage Lens

              • StorageMetrics — required — (map)

                A container for the prefix-level storage metrics for S3 Storage Lens.

                • IsEnabled — (Boolean)

                  A container for whether prefix-level storage metrics are enabled.

                • SelectionCriteria — (map)

                  • Delimiter — (String)

                    A container for the delimiter of the selection criteria being used.

                  • MaxDepth — (Integer)

                    The max depth of the selection criteria

                  • MinStorageBytesPercentage — (Float)

                    The minimum number of storage bytes percentage whose metrics will be selected.

                    Note: You must choose a value greater than or equal to 1.0.
        • Include — (map)

          A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

          • Buckets — (Array<String>)

            A container for the S3 Storage Lens bucket includes.

          • Regions — (Array<String>)

            A container for the S3 Storage Lens Region includes.

        • Exclude — (map)

          A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

          • Buckets — (Array<String>)

            A container for the S3 Storage Lens bucket excludes.

          • Regions — (Array<String>)

            A container for the S3 Storage Lens Region excludes.

        • DataExport — (map)

          A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

          • S3BucketDestination — required — (map)

            A container for the bucket where the S3 Storage Lens metrics export will be located.

            Note: This bucket must be located in the same Region as the storage lens configuration.
            • Format — required — (String)

              Possible values include:

              • "CSV"
              • "Parquet"
            • OutputSchemaVersion — required — (String)

              The schema version of the export file.

              Possible values include:
              • "V_1"
            • AccountId — required — (String)

              The account ID of the owner of the S3 Storage Lens metrics export bucket.

            • Arn — required — (String)

              The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name

            • Prefix — (String)

              The prefix of the destination bucket where the metrics export will be delivered.

            • Encryption — (map)

              The container for the type encryption of the metrics exports in this bucket.

              • SSES3 — (map)

              • SSEKMS — (map)

                • KeyId — required — (String)

                  A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e

        • IsEnabled — required — (Boolean)

          A container for whether the S3 Storage Lens configuration is enabled.

        • AwsOrg — (map)

          A container for the AWS organization for this S3 Storage Lens configuration.

          • Arn — required — (String)

            A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck

        • StorageLensArn — (String)

          The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name

Returns:

  • (AWS.Request) —

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

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

Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:GetStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the getStorageLensConfigurationTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE' /* required */
};
s3control.getStorageLensConfigurationTagging(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: {}) —
    • ConfigId — (String)

      The ID of the Amazon S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

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 — (Array<map>)

        The tags of S3 Storage Lens configuration requested.

        • Key — required — (String)

        • Value — required — (String)

Returns:

  • (AWS.Request) —

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

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

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

Service Reference:

Examples:

Calling the listAccessPoints operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3control.listAccessPoints(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: {}) —
    • AccountId — (String)

      The AWS account ID for owner of the bucket whose access points you want to list.

    • Bucket — (String)

      The name of the bucket whose associated access points you want to list.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    • NextToken — (String)

      A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

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:

      • AccessPointList — (Array<map>)

        Contains identification and configuration information for one or more access points associated with the specified bucket.

        • Name — required — (String)

          The name of this access point.

        • NetworkOrigin — required — (String)

          Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

          Possible values include:
          • "Internet"
          • "VPC"
        • VpcConfiguration — (map)

          The virtual private cloud (VPC) configuration for this access point, if one exists.

          Note: This element is empty if this access point is an Amazon S3 on Outposts access point that is used by other AWS services.
          • VpcId — required — (String)

            If this field is specified, this access point will only allow connections from the specified VPC ID.

        • Bucket — required — (String)

          The name of the bucket associated with this access point.

        • AccessPointArn — (String)

          The ARN for the access point.

      • NextToken — (String)

        If the specified bucket has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000 access points per call. If there are more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

The following actions are related to ListAccessPointsForObjectLambda:

Service Reference:

Examples:

Calling the listAccessPointsForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3control.listAccessPointsForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • NextToken — (String)

      If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

    • MaxResults — (Integer)

      The maximum number of access points that you want to include in the list. If there are more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

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:

      • ObjectLambdaAccessPointList — (Array<map>)

        Returns list of Object Lambda Access Points.

        • Name — required — (String)

          The name of the Object Lambda Access Point.

        • ObjectLambdaAccessPointArn — (String)

          Specifies the ARN for the Object Lambda Access Point.

      • NextToken — (String)

        If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.

Returns:

  • (AWS.Request) —

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

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

Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobStatuses: [
    Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready | Suspended,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
s3control.listJobs(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobStatuses — (Array<String>)

      The List Jobs request returns jobs that match the statuses listed in this element.

    • NextToken — (String)

      A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

    • MaxResults — (Integer)

      The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

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:

      • NextToken — (String)

        If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

      • Jobs — (Array<map>)

        The list of current jobs and jobs that have ended within the last 30 days.

        • JobId — (String)

          The ID for the specified job.

        • Description — (String)

          The user-specified description that was included in the specified job's Create Job request.

        • Operation — (String)

          The operation that the specified job is configured to run on every object listed in the manifest.

          Possible values include:
          • "LambdaInvoke"
          • "S3PutObjectCopy"
          • "S3PutObjectAcl"
          • "S3PutObjectTagging"
          • "S3DeleteObjectTagging"
          • "S3InitiateRestoreObject"
          • "S3PutObjectLegalHold"
          • "S3PutObjectRetention"
        • Priority — (Integer)

          The current priority for the specified job.

        • Status — (String)

          The specified job's current status.

          Possible values include:
          • "Active"
          • "Cancelled"
          • "Cancelling"
          • "Complete"
          • "Completing"
          • "Failed"
          • "Failing"
          • "New"
          • "Paused"
          • "Pausing"
          • "Preparing"
          • "Ready"
          • "Suspended"
        • CreationTime — (Date)

          A timestamp indicating when the specified job was created.

        • TerminationDate — (Date)

          A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

        • ProgressSummary — (map)

          Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

          • TotalNumberOfTasks — (Integer)

          • NumberOfTasksSucceeded — (Integer)

          • NumberOfTasksFailed — (Integer)

Returns:

  • (AWS.Request) —

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

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

Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and x-amz-outpost-id in your request, see the Examples section.

Service Reference:

Examples:

Calling the listRegionalBuckets operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OutpostId: 'STRING_VALUE'
};
s3control.listRegionalBuckets(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • NextToken — (String)

    • MaxResults — (Integer)

    • OutpostId — (String)

      The ID of the AWS Outposts.

      Note: This is required by Amazon S3 on Outposts buckets.

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:

      • RegionalBucketList — (Array<map>)

        • Bucket — required — (String)

        • BucketArn — (String)

          The Amazon Resource Name (ARN) for the regional bucket.

        • PublicAccessBlockEnabled — required — (Boolean)

        • CreationDate — required — (Date)

          The creation date of the regional bucket

        • OutpostId — (String)

          The AWS Outposts ID of the regional bucket.

      • NextToken — (String)

        NextToken is sent when isTruncated is true, which means there are more buckets that can be listed. The next list requests to Amazon S3 can be continued with this NextToken. NextToken is obfuscated and is not a real key.

Returns:

  • (AWS.Request) —

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

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

Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:ListStorageLensConfigurations action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the listStorageLensConfigurations operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
s3control.listStorageLensConfigurations(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: {}) —
    • AccountId — (String)

      The account ID of the requester.

    • NextToken — (String)

      A pagination token to request the next page of results.

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:

      • NextToken — (String)

        If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.

      • StorageLensConfigurationList — (Array<map>)

        A list of S3 Storage Lens configurations.

        • Id — required — (String)

          A container for the S3 Storage Lens configuration ID.

        • StorageLensArn — required — (String)

          The ARN of the S3 Storage Lens configuration. This property is read-only.

        • HomeRegion — required — (String)

          A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.

        • IsEnabled — (Boolean)

          A container for whether the S3 Storage Lens configuration is enabled. This property is required.

Returns:

  • (AWS.Request) —

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

populateUriFromArn(req) ⇒ void

Populate URI according to the ARN

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

Replaces configuration for an Object Lambda Access Point.

The following actions are related to PutAccessPointConfigurationForObjectLambda:

Service Reference:

Examples:

Calling the putAccessPointConfigurationForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Configuration: { /* required */
    SupportingAccessPoint: 'STRING_VALUE', /* required */
    TransformationConfigurations: [ /* required */
      {
        Actions: [ /* required */
          GetObject,
          /* more items */
        ],
        ContentTransformation: { /* required */
          AwsLambda: {
            FunctionArn: 'STRING_VALUE', /* required */
            FunctionPayload: 'STRING_VALUE'
          }
        }
      },
      /* more items */
    ],
    AllowedFeatures: [
      GetObject-Range | GetObject-PartNumber,
      /* more items */
    ],
    CloudWatchMetricsEnabled: true || false
  },
  Name: 'STRING_VALUE' /* required */
};
s3control.putAccessPointConfigurationForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point.

    • Configuration — (map)

      Object Lambda Access Point configuration document.

      • SupportingAccessPoint — required — (String)

        Standard access point associated with the Object Lambda Access Point.

      • CloudWatchMetricsEnabled — (Boolean)

        A container for whether the CloudWatch metrics configuration is enabled.

      • AllowedFeatures — (Array<String>)

        A container for allowed features. Valid inputs are GetObject-Range and GetObject-PartNumber.

      • TransformationConfigurations — required — (Array<map>)

        A container for transformation configurations for an Object Lambda Access Point.

        • Actions — required — (Array<String>)

          A container for the action of an Object Lambda Access Point configuration. Valid input is GetObject.

        • ContentTransformation — required — (map)

          A container for the content transformation of an Object Lambda Access Point configuration.

          • AwsLambda — (map)

            A container for an AWS Lambda function.

            • FunctionArn — required — (String)

              The Amazon Resource Name (ARN) of the AWS Lambda function.

            • FunctionPayload — (String)

              Additional JSON that provides supplemental data to the Lambda function used to transform objects.

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.

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

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

Service Reference:

Examples:

Calling the putAccessPointPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
s3control.putAccessPointPolicy(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: {}) —
    • AccountId — (String)

      The AWS account ID for owner of the bucket associated with the specified access point.

    • Name — (String)

      The name of the access point that you want to associate with the specified policy.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. For example, to access the access point reports-ap through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

    • Policy — (String)

      The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

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.

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

Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see Creating Object Lambda Access Points in the Amazon S3 User Guide.

The following actions are related to PutAccessPointPolicyForObjectLambda:

Service Reference:

Examples:

Calling the putAccessPointPolicyForObjectLambda operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
s3control.putAccessPointPolicyForObjectLambda(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: {}) —
    • AccountId — (String)

      The account ID for the account that owns the specified Object Lambda Access Point.

    • Name — (String)

      The name of the Object Lambda Access Point.

    • Policy — (String)

      Object Lambda Access Point resource policy document.

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.

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

Note: This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketLifecycleConfiguration:

Service Reference:

Examples:

Calling the putBucketLifecycleConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE', /* required */
  LifecycleConfiguration: {
    Rules: [
      {
        Status: Enabled | Disabled, /* required */
        AbortIncompleteMultipartUpload: {
          DaysAfterInitiation: 'NUMBER_VALUE'
        },
        Expiration: {
          Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          Days: 'NUMBER_VALUE',
          ExpiredObjectDeleteMarker: true || false
        },
        Filter: {
          And: {
            Prefix: 'STRING_VALUE',
            Tags: [
              {
                Key: 'STRING_VALUE', /* required */
                Value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          Prefix: 'STRING_VALUE',
          Tag: {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          }
        },
        ID: 'STRING_VALUE',
        NoncurrentVersionExpiration: {
          NoncurrentDays: 'NUMBER_VALUE'
        },
        NoncurrentVersionTransitions: [
          {
            NoncurrentDays: 'NUMBER_VALUE',
            StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
          },
          /* more items */
        ],
        Transitions: [
          {
            Date: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
            Days: 'NUMBER_VALUE',
            StorageClass: GLACIER | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | DEEP_ARCHIVE
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  }
};
s3control.putBucketLifecycleConfiguration(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      The name of the bucket for which to set the configuration.

    • LifecycleConfiguration — (map)

      Container for lifecycle rules. You can add as many as 1,000 rules.

      • Rules — (Array<map>)

        A lifecycle rule for individual objects in an Outposts bucket.

        • Expiration — (map)

          Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

          • Date — (Date)

            Indicates at what date the object is to be deleted. Should be in GMT ISO 8601 format.

          • Days — (Integer)

            Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

          • ExpiredObjectDeleteMarker — (Boolean)

            Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

        • ID — (String)

          Unique identifier for the rule. The value cannot be longer than 255 characters.

        • Filter — (map)

          The container for the filter of lifecycle rule.

          • Prefix — (String)

            Prefix identifying one or more objects to which the rule applies.

            Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

          • Tag — (map)

            • Key — required — (String)

            • Value — required — (String)

          • And — (map)

            The container for the AND condition for the lifecycle rule.

            • Prefix — (String)

              Prefix identifying one or more objects to which the rule applies.

            • Tags — (Array<map>)

              All of these tags must exist in the object's tag set in order for the rule to apply.

              • Key — required — (String)

              • Value — required — (String)

        • Status — required — (String)

          If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Transitions — (Array<map>)

          Specifies when an Amazon S3 object transitions to a specified storage class.

          Note: This is not supported by Amazon S3 on Outposts buckets.
          • Date — (Date)

            Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

          • Days — (Integer)

            Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

          • StorageClass — (String)

            The storage class to which you want the object to transition.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionTransitions — (Array<map>)

          Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.

          Note: This is not supported by Amazon S3 on Outposts buckets.
          • NoncurrentDays — (Integer)

            Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.

          • StorageClass — (String)

            The class of storage used to store the object.

            Possible values include:
            • "GLACIER"
            • "STANDARD_IA"
            • "ONEZONE_IA"
            • "INTELLIGENT_TIERING"
            • "DEEP_ARCHIVE"
        • NoncurrentVersionExpiration — (map)

          The noncurrent version expiration of the lifecycle rule.

          Note: This is not supported by Amazon S3 on Outposts buckets.
        • AbortIncompleteMultipartUpload — (map)

          Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon S3 User Guide.

          • DaysAfterInitiation — (Integer)

            Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload to the Outposts bucket.

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.

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

Note: This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketPolicy:

Service Reference:

Examples:

Calling the putBucketPolicy operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  ConfirmRemoveSelfBucketAccess: true || false
};
s3control.putBucketPolicy(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    • ConfirmRemoveSelfBucketAccess — (Boolean)

      Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

      Note: This is not supported by Amazon S3 on Outposts buckets.
    • Policy — (String)

      The bucket policy as a JSON document.

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.

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

Note: This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Note: Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.

PutBucketTagging has the following special errors:

  • Error code: InvalidTagError

  • Error code: MalformedXMLError

    • Description: The XML provided does not match the schema.

  • Error code: OperationAbortedError

    • Description: A conflicting conditional action is currently in progress against this resource. Try again.

  • Error code: InternalError

    • Description: The service was unable to apply the provided tag to the bucket.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

Service Reference:

Examples:

Calling the putBucketTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  Bucket: 'STRING_VALUE', /* required */
  Tagging: { /* required */
    TagSet: [ /* required */
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  }
};
s3control.putBucketTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID of the Outposts bucket.

    • Bucket — (String)

      The Amazon Resource Name (ARN) of the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the AWS SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

    • Tagging — (map)

      • TagSet — required — (Array<map>)

        A collection for a set of tags.

        • Key — required — (String)

        • Value — required — (String)

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.

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

Sets the supplied tag-set on an S3 Batch Operations job.

A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see Controlling access and labeling jobs using tags in the Amazon S3 User Guide.

Note:
  • If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing.
  • For deleting existing tags for your Batch Operations job, a DeleteJobTagging request is preferred because it achieves the same result without incurring charges.
  • A few things to consider about using tags:
    • Amazon S3 limits the maximum number of tags to 50 tags per job.
    • You can associate up to 50 tags with a job as long as they have unique tag keys.
    • A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.
    • The key and values are case sensitive.
    • For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

To use this action, you must have permission to perform the s3:PutJobTagging action.

Related actions include:

Service Reference:

Examples:

Calling the putJobTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.putJobTagging(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID for the S3 Batch Operations job whose tags you want to replace.

    • Tags — (Array<map>)

      The set of tags to associate with the S3 Batch Operations job.

      • Key — required — (String)

      • Value — required — (String)

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.

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

Creates or modifies the PublicAccessBlock configuration for an AWS account. For more information, see Using Amazon S3 block public access.

Related actions include:

Service Reference:

Examples:

Calling the putPublicAccessBlock operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  PublicAccessBlockConfiguration: { /* required */
    BlockPublicAcls: true || false,
    BlockPublicPolicy: true || false,
    IgnorePublicAcls: true || false,
    RestrictPublicBuckets: true || false
  }
};
s3control.putPublicAccessBlock(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: {}) —
    • PublicAccessBlockConfiguration — (map)

      The PublicAccessBlock configuration that you want to apply to the specified AWS account.

      • BlockPublicAcls — (Boolean)

        Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

        • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

        • PUT Object calls fail if the request includes a public ACL.

        • PUT Bucket calls fail if the request includes a public ACL.

        Enabling this setting doesn't affect existing policies or ACLs.

        This is not supported for Amazon S3 on Outposts.

      • IgnorePublicAcls — (Boolean)

        Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

        Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

        This is not supported for Amazon S3 on Outposts.

      • BlockPublicPolicy — (Boolean)

        Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

        Enabling this setting doesn't affect existing bucket policies.

        This is not supported for Amazon S3 on Outposts.

      • RestrictPublicBuckets — (Boolean)

        Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

        Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

        This is not supported for Amazon S3 on Outposts.

    • AccountId — (String)

      The account ID for the AWS account whose PublicAccessBlock configuration you want to set.

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.

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

Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Working with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:PutStorageLensConfiguration action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the putStorageLensConfiguration operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE', /* required */
  StorageLensConfiguration: { /* required */
    AccountLevel: { /* required */
      BucketLevel: { /* required */
        ActivityMetrics: {
          IsEnabled: true || false
        },
        PrefixLevel: {
          StorageMetrics: { /* required */
            IsEnabled: true || false,
            SelectionCriteria: {
              Delimiter: 'STRING_VALUE',
              MaxDepth: 'NUMBER_VALUE',
              MinStorageBytesPercentage: 'NUMBER_VALUE'
            }
          }
        }
      },
      ActivityMetrics: {
        IsEnabled: true || false
      }
    },
    Id: 'STRING_VALUE', /* required */
    IsEnabled: true || false, /* required */
    AwsOrg: {
      Arn: 'STRING_VALUE' /* required */
    },
    DataExport: {
      S3BucketDestination: { /* required */
        AccountId: 'STRING_VALUE', /* required */
        Arn: 'STRING_VALUE', /* required */
        Format: CSV | Parquet, /* required */
        OutputSchemaVersion: V_1, /* required */
        Encryption: {
          SSEKMS: {
            KeyId: 'STRING_VALUE' /* required */
          },
          SSES3: {
          }
        },
        Prefix: 'STRING_VALUE'
      }
    },
    Exclude: {
      Buckets: [
        'STRING_VALUE',
        /* more items */
      ],
      Regions: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Include: {
      Buckets: [
        'STRING_VALUE',
        /* more items */
      ],
      Regions: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    StorageLensArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.putStorageLensConfiguration(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: {}) —
    • ConfigId — (String)

      The ID of the S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

    • StorageLensConfiguration — (map)

      The S3 Storage Lens configuration.

      • Id — required — (String)

        A container for the Amazon S3 Storage Lens configuration ID.

      • AccountLevel — required — (map)

        A container for all the account-level configurations of your S3 Storage Lens configuration.

        • ActivityMetrics — (map)

          A container for the S3 Storage Lens activity metrics.

          • IsEnabled — (Boolean)

            A container for whether the activity metrics are enabled.

        • BucketLevel — required — (map)

          A container for the S3 Storage Lens bucket-level configuration.

          • ActivityMetrics — (map)

            A container for the bucket-level activity metrics for Amazon S3 Storage Lens

            • IsEnabled — (Boolean)

              A container for whether the activity metrics are enabled.

          • PrefixLevel — (map)

            A container for the bucket-level prefix-level metrics for S3 Storage Lens

            • StorageMetrics — required — (map)

              A container for the prefix-level storage metrics for S3 Storage Lens.

              • IsEnabled — (Boolean)

                A container for whether prefix-level storage metrics are enabled.

              • SelectionCriteria — (map)

                • Delimiter — (String)

                  A container for the delimiter of the selection criteria being used.

                • MaxDepth — (Integer)

                  The max depth of the selection criteria

                • MinStorageBytesPercentage — (Float)

                  The minimum number of storage bytes percentage whose metrics will be selected.

                  Note: You must choose a value greater than or equal to 1.0.
      • Include — (map)

        A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

        • Buckets — (Array<String>)

          A container for the S3 Storage Lens bucket includes.

        • Regions — (Array<String>)

          A container for the S3 Storage Lens Region includes.

      • Exclude — (map)

        A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

        • Buckets — (Array<String>)

          A container for the S3 Storage Lens bucket excludes.

        • Regions — (Array<String>)

          A container for the S3 Storage Lens Region excludes.

      • DataExport — (map)

        A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

        • S3BucketDestination — required — (map)

          A container for the bucket where the S3 Storage Lens metrics export will be located.

          Note: This bucket must be located in the same Region as the storage lens configuration.
          • Format — required — (String)

            Possible values include:

            • "CSV"
            • "Parquet"
          • OutputSchemaVersion — required — (String)

            The schema version of the export file.

            Possible values include:
            • "V_1"
          • AccountId — required — (String)

            The account ID of the owner of the S3 Storage Lens metrics export bucket.

          • Arn — required — (String)

            The Amazon Resource Name (ARN) of the bucket. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:bucket/your-destination-bucket-name

          • Prefix — (String)

            The prefix of the destination bucket where the metrics export will be delivered.

          • Encryption — (map)

            The container for the type encryption of the metrics exports in this bucket.

            • SSES3 — (map)

            • SSEKMS — (map)

              • KeyId — required — (String)

                A container for the ARN of the SSE-KMS encryption. This property is read-only and follows the following format: arn:aws:kms:us-east-1:example-account-id:key/example-9a73-4afc-8d29-8f5900cef44e

      • IsEnabled — required — (Boolean)

        A container for whether the S3 Storage Lens configuration is enabled.

      • AwsOrg — (map)

        A container for the AWS organization for this S3 Storage Lens configuration.

        • Arn — required — (String)

          A container for the Amazon Resource Name (ARN) of the AWS organization. This property is read-only and follows the following format: arn:aws:organizations:us-east-1:example-account-id:organization/o-ex2l495dck

      • StorageLensArn — (String)

        The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name

    • Tags — (Array<map>)

      The tag set of the S3 Storage Lens configuration.

      Note: You can set up to a maximum of 50 tags.
      • Key — required — (String)

      • Value — required — (String)

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.

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

Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see Assessing your storage activity and usage with Amazon S3 Storage Lens in the Amazon S3 User Guide.

Note: To use this action, you must have permission to perform the s3:PutStorageLensConfigurationTagging action. For more information, see Setting permissions to use Amazon S3 Storage Lens in the Amazon S3 User Guide.

Service Reference:

Examples:

Calling the putStorageLensConfigurationTagging operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ConfigId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
s3control.putStorageLensConfigurationTagging(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: {}) —
    • ConfigId — (String)

      The ID of the S3 Storage Lens configuration.

    • AccountId — (String)

      The account ID of the requester.

    • Tags — (Array<map>)

      The tag set of the S3 Storage Lens configuration.

      Note: You can set up to a maximum of 50 tags.
      • Key — required — (String)

      • Value — required — (String)

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.

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

Updates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the updateJobPriority operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  Priority: 'NUMBER_VALUE' /* required */
};
s3control.updateJobPriority(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID for the job whose priority you want to update.

    • Priority — (Integer)

      The priority you want to assign to this job.

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:

      • JobId — (String)

        The ID for the job whose priority Amazon S3 updated.

      • Priority — (Integer)

        The new priority assigned to the specified job.

Returns:

  • (AWS.Request) —

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

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

Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see S3 Batch Operations in the Amazon S3 User Guide.

Related actions include:

Service Reference:

Examples:

Calling the updateJobStatus operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE', /* required */
  RequestedJobStatus: Cancelled | Ready, /* required */
  StatusUpdateReason: 'STRING_VALUE'
};
s3control.updateJobStatus(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: {}) —
    • AccountId — (String)

      The AWS account ID associated with the S3 Batch Operations job.

    • JobId — (String)

      The ID of the job whose status you want to update.

    • RequestedJobStatus — (String)

      The status that you want to move the specified job to.

      Possible values include:
      • "Cancelled"
      • "Ready"
    • StatusUpdateReason — (String)

      A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.

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:

      • JobId — (String)

        The ID for the job whose status was updated.

      • Status — (String)

        The current status for the specified job.

        Possible values include:
        • "Active"
        • "Cancelled"
        • "Cancelling"
        • "Complete"
        • "Completing"
        • "Failed"
        • "Failing"
        • "New"
        • "Paused"
        • "Pausing"
        • "Preparing"
        • "Ready"
        • "Suspended"
      • StatusUpdateReason — (String)

        The reason that the specified job's status was updated.

Returns:

  • (AWS.Request) —

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

validateOutpostsBucketArn(req) ⇒ void

Validate Outposts ARN supplied in Bucket parameter is a valid bucket name