AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . s3control ]

create-access-point-for-object-lambda

Description

Note

This operation is not supported by directory buckets.

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 :

See also: AWS API Documentation

Synopsis

  create-access-point-for-object-lambda
--account-id <value>
--name <value>
--configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--account-id (string)

The Amazon Web Services 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 (structure)

Object Lambda Access Point configuration as a JSON document.

SupportingAccessPoint -> (string)

Standard access point associated with the Object Lambda Access Point.

CloudWatchMetricsEnabled -> (boolean)

A container for whether the CloudWatch metrics configuration is enabled.

AllowedFeatures -> (list)

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

(string)

TransformationConfigurations -> (list)

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

(structure)

A configuration used when creating an Object Lambda Access Point transformation.

Actions -> (list)

A container for the action of an Object Lambda Access Point configuration. Valid inputs are GetObject , ListObjects , HeadObject , and ListObjectsV2 .

(string)

ContentTransformation -> (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AwsLambda.

AwsLambda -> (structure)

A container for an Lambda function.

FunctionArn -> (string)

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

FunctionPayload -> (string)

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

JSON Syntax:

{
  "SupportingAccessPoint": "string",
  "CloudWatchMetricsEnabled": true|false,
  "AllowedFeatures": ["GetObject-Range"|"GetObject-PartNumber"|"HeadObject-Range"|"HeadObject-PartNumber", ...],
  "TransformationConfigurations": [
    {
      "Actions": ["GetObject"|"HeadObject"|"ListObjects"|"ListObjectsV2", ...],
      "ContentTransformation": {
        "AwsLambda": {
          "FunctionArn": "string",
          "FunctionPayload": "string"
        }
      }
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ObjectLambdaAccessPointArn -> (string)

Specifies the ARN for the Object Lambda Access Point.

Alias -> (structure)

The alias of the Object Lambda Access Point.

Value -> (string)

The alias value of the Object Lambda Access Point.

Status -> (string)

The status of the Object Lambda Access Point alias. If the status is PROVISIONING , the Object Lambda Access Point is provisioning the alias and the alias is not ready for use yet. If the status is READY , the Object Lambda Access Point alias is successfully provisioned and ready for use.