S3Files / Client / put_synchronization_configuration

put_synchronization_configuration

S3Files.Client.put_synchronization_configuration(**kwargs)

Creates or updates the synchronization configuration for the specified S3 File System, including import data rules and expiration data rules.

See also: AWS API Documentation

Request Syntax

response = client.put_synchronization_configuration(
    fileSystemId='string',
    latestVersionNumber=123,
    importDataRules=[
        {
            'prefix': 'string',
            'trigger': 'ON_DIRECTORY_FIRST_ACCESS'|'ON_FILE_ACCESS',
            'sizeLessThan': 123
        },
    ],
    expirationDataRules=[
        {
            'daysAfterLastAccess': 123
        },
    ]
)
Parameters:

  • fileSystemId (string) –

    [REQUIRED]

    The ID or Amazon Resource Name (ARN) of the S3 File System to configure synchronization for.

  • latestVersionNumber (integer) – The version number of the current synchronization configuration. Omit this value when creating a synchronization configuration for the first time. For subsequent updates, provide this value for optimistic concurrency control. If the version number does not match the current configuration, the request fails with a ConflictException.

  • importDataRules (list) –

    [REQUIRED]

    An array of import data rules that control how data is imported from S3 into the file system.

    • (dict) –

      Specifies a rule that controls how data is imported from S3 into the file system.

      • prefix (string) – [REQUIRED]

        The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.

      • trigger (string) – [REQUIRED]

        The event that triggers data import. Valid values are ON_DIRECTORY_FIRST_ACCESS (import when a directory is first accessed) and ON_FILE_ACCESS (import when a file is accessed).

      • sizeLessThan (integer) – [REQUIRED]

        The upper size limit in bytes for this import rule. Only objects with a size strictly less than this value will have data imported into the file system.

  • expirationDataRules (list) –

    [REQUIRED]

    An array of expiration data rules that control when cached data expires from the file system.

    • (dict) –

      Specifies a rule that controls when cached data expires from the file system based on last access time.

      • daysAfterLastAccess (integer) – [REQUIRED]

        The number of days after last access before cached data expires from the file system.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions