S3Control / Client / create_access_point_for_object_lambda

create_access_point_for_object_lambda#

S3Control.Client.create_access_point_for_object_lambda(**kwargs)#

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

Request Syntax

response = client.create_access_point_for_object_lambda(
    AccountId='string',
    Name='string',
    Configuration={
        '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'
                    }
                }
            },
        ]
    }
)
Parameters:
  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID for owner of the specified Object Lambda Access Point.

  • Name (string) –

    [REQUIRED]

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

  • Configuration (dict) –

    [REQUIRED]

    Object Lambda Access Point configuration as a JSON document.

    • SupportingAccessPoint (string) – [REQUIRED]

      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) – [REQUIRED]

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

      • (dict) –

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

        • Actions (list) – [REQUIRED]

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

          • (string) –

        • ContentTransformation (dict) – [REQUIRED]

          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 (dict) –

            A container for an Lambda function.

            • FunctionArn (string) – [REQUIRED]

              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.

Return type:

dict

Returns:

Response Syntax

{
    'ObjectLambdaAccessPointArn': 'string',
    'Alias': {
        'Value': 'string',
        'Status': 'PROVISIONING'|'READY'
    }
}

Response Structure

  • (dict) –

    • ObjectLambdaAccessPointArn (string) –

      Specifies the ARN for the Object Lambda Access Point.

    • Alias (dict) –

      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.