S3Files / Client / create_access_point

create_access_point

S3Files.Client.create_access_point(**kwargs)

Creates an S3 File System Access Point for application-specific access with POSIX user identity and root directory enforcement. Access points provide a way to manage access to shared datasets in multi-tenant scenarios.

See also: AWS API Documentation

Request Syntax

response = client.create_access_point(
    clientToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    fileSystemId='string',
    posixUser={
        'uid': 123,
        'gid': 123,
        'secondaryGids': [
            123,
        ]
    },
    rootDirectory={
        'path': 'string',
        'creationPermissions': {
            'ownerUid': 123,
            'ownerGid': 123,
            'permissions': 'string'
        }
    }
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Web Services ignores the request, but does not return an error.

    This field is autopopulated if not provided.

  • tags (list) –

    An array of key-value pairs to apply to the access point for resource tagging.

    • (dict) –

      A key-value pair for resource tagging.

      • key (string) – [REQUIRED]

        The tag key. The key can’t start with aws:.

      • value (string) – [REQUIRED]

        The tag value.

  • fileSystemId (string) –

    [REQUIRED]

    The ID or Amazon Resource Name (ARN) of the S3 File System.

  • posixUser (dict) –

    The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point.

    • uid (integer) – [REQUIRED]

      The POSIX user ID.

    • gid (integer) – [REQUIRED]

      The POSIX group ID.

    • secondaryGids (list) –

      An array of secondary POSIX group IDs.

      • (integer) –

  • rootDirectory (dict) –

    The root directory path for the access point, with optional creation permissions for newly created directories.

    • path (string) –

      The path to use as the root directory for the access point.

    • creationPermissions (dict) –

      The permissions to set on newly created directories.

      • ownerUid (integer) – [REQUIRED]

        The POSIX user ID to assign to newly created directories.

      • ownerGid (integer) – [REQUIRED]

        The POSIX group ID to assign to newly created directories.

      • permissions (string) – [REQUIRED]

        The octal permissions to assign to newly created directories.

Return type:

dict

Returns:

Response Syntax

{
    'accessPointArn': 'string',
    'accessPointId': 'string',
    'clientToken': 'string',
    'fileSystemId': 'string',
    'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
    'ownerId': 'string',
    'posixUser': {
        'uid': 123,
        'gid': 123,
        'secondaryGids': [
            123,
        ]
    },
    'rootDirectory': {
        'path': 'string',
        'creationPermissions': {
            'ownerUid': 123,
            'ownerGid': 123,
            'permissions': 'string'
        }
    },
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'name': 'string'
}

Response Structure

  • (dict) –

    • accessPointArn (string) –

      The Amazon Resource Name (ARN) of the access point.

    • accessPointId (string) –

      The ID of the access point.

    • clientToken (string) –

      The client token that was provided in the request.

    • fileSystemId (string) –

      The ID of the S3 File System.

    • status (string) –

      The current status of the access point.

    • ownerId (string) –

      The Amazon Web Services account ID of the access point owner.

    • posixUser (dict) –

      The POSIX identity configured for this access point.

      • uid (integer) –

        The POSIX user ID.

      • gid (integer) –

        The POSIX group ID.

      • secondaryGids (list) –

        An array of secondary POSIX group IDs.

        • (integer) –

    • rootDirectory (dict) –

      The root directory configuration for this access point.

      • path (string) –

        The path to use as the root directory for the access point.

      • creationPermissions (dict) –

        The permissions to set on newly created directories.

        • ownerUid (integer) –

          The POSIX user ID to assign to newly created directories.

        • ownerGid (integer) –

          The POSIX group ID to assign to newly created directories.

        • permissions (string) –

          The octal permissions to assign to newly created directories.

    • tags (list) –

      The tags associated with the access point.

      • (dict) –

        A key-value pair for resource tagging.

        • key (string) –

          The tag key. The key can’t start with aws:.

        • value (string) –

          The tag value.

    • name (string) –

      The name of the access point.

Exceptions