S3Files / Client / get_synchronization_configuration

get_synchronization_configuration¶

S3Files.Client.get_synchronization_configuration(**kwargs)¶

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

Request Syntax

response = client.get_synchronization_configuration(
    fileSystemId='string'
)

Parameters:

fileSystemId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'latestVersionNumber': 123,
    'importDataRules': [
        {
            'prefix': 'string',
            'trigger': 'ON_DIRECTORY_FIRST_ACCESS'|'ON_FILE_ACCESS',
            'sizeLessThan': 123
        },
    ],
    'expirationDataRules': [
        {
            'daysAfterLastAccess': 123
        },
    ]
}

Response Structure

(dict) –
- latestVersionNumber (integer) –
  
  The version number of the synchronization configuration. Use this value with PutSynchronizationConfiguration to ensure optimistic concurrency control.
- importDataRules (list) –
  
  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) –
      
      The S3 key prefix that scopes this import rule. Only objects with keys beginning with this prefix are subject to the rule.
    - trigger (string) –
      
      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) –
      
      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) –
  
  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) –
      
      The number of days after last access before cached data expires from the file system.

Exceptions

S3Files.Client.exceptions.InternalServerException
S3Files.Client.exceptions.ResourceNotFoundException
S3Files.Client.exceptions.ThrottlingException
S3Files.Client.exceptions.ValidationException