:doc:`FSx <../../fsx>` / Paginator / DescribeBackups

***************
DescribeBackups
***************



.. py:class:: FSx.Paginator.DescribeBackups

  ::

    
    paginator = client.get_paginator('describe_backups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`FSx.Client.describe_backups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          BackupIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'file-system-id'|'backup-type'|'file-system-type'|'volume-id'|'data-repository-type'|'file-cache-id'|'file-cache-type',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type BackupIds: list
    :param BackupIds: 

      The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a ``BackupNotFound`` error occurs.

      

    
      - *(string) --* 

        The ID of the source backup. Specifies the backup that you are copying.

        

      
  
    :type Filters: list
    :param Filters: 

      The filters structure. The supported names are ``file-system-id``, ``backup-type``, ``file-system-type``, and ``volume-id``.

      

    
      - *(dict) --* 

        A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

        

      
        - **Name** *(string) --* 

          The name for this filter.

          

        
        - **Values** *(list) --* 

          The values of the filter. These are all the values for any of the applied filters.

          

        
          - *(string) --* 

            The value for a filter.

            

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Backups': [
                {
                    'BackupId': 'string',
                    'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING',
                    'FailureDetails': {
                        'Message': 'string'
                    },
                    'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP',
                    'ProgressPercent': 123,
                    'CreationTime': datetime(2015, 1, 1),
                    'KmsKeyId': 'string',
                    'ResourceARN': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'FileSystem': {
                        'OwnerId': 'string',
                        'CreationTime': datetime(2015, 1, 1),
                        'FileSystemId': 'string',
                        'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS',
                        'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE',
                        'FailureDetails': {
                            'Message': 'string'
                        },
                        'StorageCapacity': 123,
                        'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING',
                        'VpcId': 'string',
                        'SubnetIds': [
                            'string',
                        ],
                        'NetworkInterfaceIds': [
                            'string',
                        ],
                        'DNSName': 'string',
                        'KmsKeyId': 'string',
                        'ResourceARN': 'string',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'WindowsConfiguration': {
                            'ActiveDirectoryId': 'string',
                            'SelfManagedActiveDirectoryConfiguration': {
                                'DomainName': 'string',
                                'OrganizationalUnitDistinguishedName': 'string',
                                'FileSystemAdministratorsGroup': 'string',
                                'UserName': 'string',
                                'DnsIps': [
                                    'string',
                                ],
                                'DomainJoinServiceAccountSecret': 'string'
                            },
                            'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
                            'RemoteAdministrationEndpoint': 'string',
                            'PreferredSubnetId': 'string',
                            'PreferredFileServerIp': 'string',
                            'ThroughputCapacity': 123,
                            'MaintenanceOperationsInProgress': [
                                'PATCHING'|'BACKING_UP',
                            ],
                            'WeeklyMaintenanceStartTime': 'string',
                            'DailyAutomaticBackupStartTime': 'string',
                            'AutomaticBackupRetentionDays': 123,
                            'CopyTagsToBackups': True|False,
                            'Aliases': [
                                {
                                    'Name': 'string',
                                    'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
                                },
                            ],
                            'AuditLogConfiguration': {
                                'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                                'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                                'AuditLogDestination': 'string'
                            },
                            'DiskIopsConfiguration': {
                                'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                'Iops': 123
                            },
                            'PreferredFileServerIpv6': 'string',
                            'FsrmConfiguration': {
                                'FsrmServiceEnabled': True|False,
                                'EventLogDestination': 'string'
                            }
                        },
                        'LustreConfiguration': {
                            'WeeklyMaintenanceStartTime': 'string',
                            'DataRepositoryConfiguration': {
                                'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED',
                                'ImportPath': 'string',
                                'ExportPath': 'string',
                                'ImportedFileChunkSize': 123,
                                'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED',
                                'FailureDetails': {
                                    'Message': 'string'
                                }
                            },
                            'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2',
                            'PerUnitStorageThroughput': 123,
                            'MountName': 'string',
                            'DailyAutomaticBackupStartTime': 'string',
                            'AutomaticBackupRetentionDays': 123,
                            'CopyTagsToBackups': True|False,
                            'DriveCacheType': 'NONE'|'READ',
                            'DataCompressionType': 'NONE'|'LZ4',
                            'LogConfiguration': {
                                'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR',
                                'Destination': 'string'
                            },
                            'RootSquashConfiguration': {
                                'RootSquash': 'string',
                                'NoSquashNids': [
                                    'string',
                                ]
                            },
                            'MetadataConfiguration': {
                                'Iops': 123,
                                'Mode': 'AUTOMATIC'|'USER_PROVISIONED'
                            },
                            'EfaEnabled': True|False,
                            'ThroughputCapacity': 123,
                            'DataReadCacheConfiguration': {
                                'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                'SizeGiB': 123
                            }
                        },
                        'AdministrativeActions': [
                            {
                                'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION'|'VOLUME_UPDATE'|'SNAPSHOT_UPDATE'|'RELEASE_NFS_V3_LOCKS'|'VOLUME_RESTORE'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP',
                                'ProgressPercent': 123,
                                'RequestTime': datetime(2015, 1, 1),
                                'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING'|'PAUSED'|'CANCELLED',
                                'TargetFileSystemValues': {'... recursive ...'},
                                'FailureDetails': {
                                    'Message': 'string'
                                },
                                'TargetVolumeValues': {
                                    'CreationTime': datetime(2015, 1, 1),
                                    'FileSystemId': 'string',
                                    'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE',
                                    'Name': 'string',
                                    'OntapConfiguration': {
                                        'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
                                        'JunctionPath': 'string',
                                        'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
                                        'SizeInMegabytes': 123,
                                        'StorageEfficiencyEnabled': True|False,
                                        'StorageVirtualMachineId': 'string',
                                        'StorageVirtualMachineRoot': True|False,
                                        'TieringPolicy': {
                                            'CoolingPeriod': 123,
                                            'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
                                        },
                                        'UUID': 'string',
                                        'OntapVolumeType': 'RW'|'DP'|'LS',
                                        'SnapshotPolicy': 'string',
                                        'CopyTagsToBackups': True|False,
                                        'SnaplockConfiguration': {
                                            'AuditLogVolume': True|False,
                                            'AutocommitPeriod': {
                                                'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE',
                                                'Value': 123
                                            },
                                            'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED',
                                            'RetentionPeriod': {
                                                'DefaultRetention': {
                                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                                    'Value': 123
                                                },
                                                'MinimumRetention': {
                                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                                    'Value': 123
                                                },
                                                'MaximumRetention': {
                                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                                    'Value': 123
                                                }
                                            },
                                            'SnaplockType': 'COMPLIANCE'|'ENTERPRISE',
                                            'VolumeAppendModeEnabled': True|False
                                        },
                                        'VolumeStyle': 'FLEXVOL'|'FLEXGROUP',
                                        'AggregateConfiguration': {
                                            'Aggregates': [
                                                'string',
                                            ],
                                            'TotalConstituents': 123
                                        },
                                        'SizeInBytes': 123
                                    },
                                    'ResourceARN': 'string',
                                    'Tags': [
                                        {
                                            'Key': 'string',
                                            'Value': 'string'
                                        },
                                    ],
                                    'VolumeId': 'string',
                                    'VolumeType': 'ONTAP'|'OPENZFS',
                                    'LifecycleTransitionReason': {
                                        'Message': 'string'
                                    },
                                    'AdministrativeActions': {'... recursive ...'},
                                    'OpenZFSConfiguration': {
                                        'ParentVolumeId': 'string',
                                        'VolumePath': 'string',
                                        'StorageCapacityReservationGiB': 123,
                                        'StorageCapacityQuotaGiB': 123,
                                        'RecordSizeKiB': 123,
                                        'DataCompressionType': 'NONE'|'ZSTD'|'LZ4',
                                        'CopyTagsToSnapshots': True|False,
                                        'OriginSnapshot': {
                                            'SnapshotARN': 'string',
                                            'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                                        },
                                        'ReadOnly': True|False,
                                        'NfsExports': [
                                            {
                                                'ClientConfigurations': [
                                                    {
                                                        'Clients': 'string',
                                                        'Options': [
                                                            'string',
                                                        ]
                                                    },
                                                ]
                                            },
                                        ],
                                        'UserAndGroupQuotas': [
                                            {
                                                'Type': 'USER'|'GROUP',
                                                'Id': 123,
                                                'StorageCapacityQuotaGiB': 123
                                            },
                                        ],
                                        'RestoreToSnapshot': 'string',
                                        'DeleteIntermediateSnaphots': True|False,
                                        'DeleteClonedVolumes': True|False,
                                        'DeleteIntermediateData': True|False,
                                        'SourceSnapshotARN': 'string',
                                        'DestinationSnapshot': 'string',
                                        'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                                    }
                                },
                                'TargetSnapshotValues': {
                                    'ResourceARN': 'string',
                                    'SnapshotId': 'string',
                                    'Name': 'string',
                                    'VolumeId': 'string',
                                    'CreationTime': datetime(2015, 1, 1),
                                    'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE',
                                    'LifecycleTransitionReason': {
                                        'Message': 'string'
                                    },
                                    'Tags': [
                                        {
                                            'Key': 'string',
                                            'Value': 'string'
                                        },
                                    ],
                                    'AdministrativeActions': {'... recursive ...'}
                                },
                                'TotalTransferBytes': 123,
                                'RemainingTransferBytes': 123,
                                'Message': 'string'
                            },
                        ],
                        'OntapConfiguration': {
                            'AutomaticBackupRetentionDays': 123,
                            'DailyAutomaticBackupStartTime': 'string',
                            'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2',
                            'EndpointIpAddressRange': 'string',
                            'Endpoints': {
                                'Intercluster': {
                                    'DNSName': 'string',
                                    'IpAddresses': [
                                        'string',
                                    ],
                                    'Ipv6Addresses': [
                                        'string',
                                    ]
                                },
                                'Management': {
                                    'DNSName': 'string',
                                    'IpAddresses': [
                                        'string',
                                    ],
                                    'Ipv6Addresses': [
                                        'string',
                                    ]
                                }
                            },
                            'DiskIopsConfiguration': {
                                'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                'Iops': 123
                            },
                            'PreferredSubnetId': 'string',
                            'RouteTableIds': [
                                'string',
                            ],
                            'ThroughputCapacity': 123,
                            'WeeklyMaintenanceStartTime': 'string',
                            'FsxAdminPassword': 'string',
                            'HAPairs': 123,
                            'ThroughputCapacityPerHAPair': 123,
                            'EndpointIpv6AddressRange': 'string'
                        },
                        'FileSystemTypeVersion': 'string',
                        'OpenZFSConfiguration': {
                            'AutomaticBackupRetentionDays': 123,
                            'CopyTagsToBackups': True|False,
                            'CopyTagsToVolumes': True|False,
                            'DailyAutomaticBackupStartTime': 'string',
                            'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1',
                            'ThroughputCapacity': 123,
                            'WeeklyMaintenanceStartTime': 'string',
                            'DiskIopsConfiguration': {
                                'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                'Iops': 123
                            },
                            'RootVolumeId': 'string',
                            'PreferredSubnetId': 'string',
                            'EndpointIpAddressRange': 'string',
                            'EndpointIpv6AddressRange': 'string',
                            'RouteTableIds': [
                                'string',
                            ],
                            'EndpointIpAddress': 'string',
                            'EndpointIpv6Address': 'string',
                            'ReadCacheConfiguration': {
                                'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                'SizeGiB': 123
                            }
                        },
                        'NetworkType': 'IPV4'|'DUAL'
                    },
                    'DirectoryInformation': {
                        'DomainName': 'string',
                        'ActiveDirectoryId': 'string',
                        'ResourceARN': 'string'
                    },
                    'OwnerId': 'string',
                    'SourceBackupId': 'string',
                    'SourceBackupRegion': 'string',
                    'ResourceType': 'FILE_SYSTEM'|'VOLUME',
                    'Volume': {
                        'CreationTime': datetime(2015, 1, 1),
                        'FileSystemId': 'string',
                        'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE',
                        'Name': 'string',
                        'OntapConfiguration': {
                            'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
                            'JunctionPath': 'string',
                            'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
                            'SizeInMegabytes': 123,
                            'StorageEfficiencyEnabled': True|False,
                            'StorageVirtualMachineId': 'string',
                            'StorageVirtualMachineRoot': True|False,
                            'TieringPolicy': {
                                'CoolingPeriod': 123,
                                'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
                            },
                            'UUID': 'string',
                            'OntapVolumeType': 'RW'|'DP'|'LS',
                            'SnapshotPolicy': 'string',
                            'CopyTagsToBackups': True|False,
                            'SnaplockConfiguration': {
                                'AuditLogVolume': True|False,
                                'AutocommitPeriod': {
                                    'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE',
                                    'Value': 123
                                },
                                'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED',
                                'RetentionPeriod': {
                                    'DefaultRetention': {
                                        'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                        'Value': 123
                                    },
                                    'MinimumRetention': {
                                        'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                        'Value': 123
                                    },
                                    'MaximumRetention': {
                                        'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                        'Value': 123
                                    }
                                },
                                'SnaplockType': 'COMPLIANCE'|'ENTERPRISE',
                                'VolumeAppendModeEnabled': True|False
                            },
                            'VolumeStyle': 'FLEXVOL'|'FLEXGROUP',
                            'AggregateConfiguration': {
                                'Aggregates': [
                                    'string',
                                ],
                                'TotalConstituents': 123
                            },
                            'SizeInBytes': 123
                        },
                        'ResourceARN': 'string',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ],
                        'VolumeId': 'string',
                        'VolumeType': 'ONTAP'|'OPENZFS',
                        'LifecycleTransitionReason': {
                            'Message': 'string'
                        },
                        'AdministrativeActions': [
                            {
                                'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION'|'VOLUME_UPDATE'|'SNAPSHOT_UPDATE'|'RELEASE_NFS_V3_LOCKS'|'VOLUME_RESTORE'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP',
                                'ProgressPercent': 123,
                                'RequestTime': datetime(2015, 1, 1),
                                'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING'|'PAUSED'|'CANCELLED',
                                'TargetFileSystemValues': {
                                    'OwnerId': 'string',
                                    'CreationTime': datetime(2015, 1, 1),
                                    'FileSystemId': 'string',
                                    'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS',
                                    'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE',
                                    'FailureDetails': {
                                        'Message': 'string'
                                    },
                                    'StorageCapacity': 123,
                                    'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING',
                                    'VpcId': 'string',
                                    'SubnetIds': [
                                        'string',
                                    ],
                                    'NetworkInterfaceIds': [
                                        'string',
                                    ],
                                    'DNSName': 'string',
                                    'KmsKeyId': 'string',
                                    'ResourceARN': 'string',
                                    'Tags': [
                                        {
                                            'Key': 'string',
                                            'Value': 'string'
                                        },
                                    ],
                                    'WindowsConfiguration': {
                                        'ActiveDirectoryId': 'string',
                                        'SelfManagedActiveDirectoryConfiguration': {
                                            'DomainName': 'string',
                                            'OrganizationalUnitDistinguishedName': 'string',
                                            'FileSystemAdministratorsGroup': 'string',
                                            'UserName': 'string',
                                            'DnsIps': [
                                                'string',
                                            ],
                                            'DomainJoinServiceAccountSecret': 'string'
                                        },
                                        'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
                                        'RemoteAdministrationEndpoint': 'string',
                                        'PreferredSubnetId': 'string',
                                        'PreferredFileServerIp': 'string',
                                        'ThroughputCapacity': 123,
                                        'MaintenanceOperationsInProgress': [
                                            'PATCHING'|'BACKING_UP',
                                        ],
                                        'WeeklyMaintenanceStartTime': 'string',
                                        'DailyAutomaticBackupStartTime': 'string',
                                        'AutomaticBackupRetentionDays': 123,
                                        'CopyTagsToBackups': True|False,
                                        'Aliases': [
                                            {
                                                'Name': 'string',
                                                'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
                                            },
                                        ],
                                        'AuditLogConfiguration': {
                                            'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                                            'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                                            'AuditLogDestination': 'string'
                                        },
                                        'DiskIopsConfiguration': {
                                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                            'Iops': 123
                                        },
                                        'PreferredFileServerIpv6': 'string',
                                        'FsrmConfiguration': {
                                            'FsrmServiceEnabled': True|False,
                                            'EventLogDestination': 'string'
                                        }
                                    },
                                    'LustreConfiguration': {
                                        'WeeklyMaintenanceStartTime': 'string',
                                        'DataRepositoryConfiguration': {
                                            'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED',
                                            'ImportPath': 'string',
                                            'ExportPath': 'string',
                                            'ImportedFileChunkSize': 123,
                                            'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED',
                                            'FailureDetails': {
                                                'Message': 'string'
                                            }
                                        },
                                        'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2',
                                        'PerUnitStorageThroughput': 123,
                                        'MountName': 'string',
                                        'DailyAutomaticBackupStartTime': 'string',
                                        'AutomaticBackupRetentionDays': 123,
                                        'CopyTagsToBackups': True|False,
                                        'DriveCacheType': 'NONE'|'READ',
                                        'DataCompressionType': 'NONE'|'LZ4',
                                        'LogConfiguration': {
                                            'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR',
                                            'Destination': 'string'
                                        },
                                        'RootSquashConfiguration': {
                                            'RootSquash': 'string',
                                            'NoSquashNids': [
                                                'string',
                                            ]
                                        },
                                        'MetadataConfiguration': {
                                            'Iops': 123,
                                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED'
                                        },
                                        'EfaEnabled': True|False,
                                        'ThroughputCapacity': 123,
                                        'DataReadCacheConfiguration': {
                                            'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                            'SizeGiB': 123
                                        }
                                    },
                                    'AdministrativeActions': {'... recursive ...'},
                                    'OntapConfiguration': {
                                        'AutomaticBackupRetentionDays': 123,
                                        'DailyAutomaticBackupStartTime': 'string',
                                        'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2',
                                        'EndpointIpAddressRange': 'string',
                                        'Endpoints': {
                                            'Intercluster': {
                                                'DNSName': 'string',
                                                'IpAddresses': [
                                                    'string',
                                                ],
                                                'Ipv6Addresses': [
                                                    'string',
                                                ]
                                            },
                                            'Management': {
                                                'DNSName': 'string',
                                                'IpAddresses': [
                                                    'string',
                                                ],
                                                'Ipv6Addresses': [
                                                    'string',
                                                ]
                                            }
                                        },
                                        'DiskIopsConfiguration': {
                                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                            'Iops': 123
                                        },
                                        'PreferredSubnetId': 'string',
                                        'RouteTableIds': [
                                            'string',
                                        ],
                                        'ThroughputCapacity': 123,
                                        'WeeklyMaintenanceStartTime': 'string',
                                        'FsxAdminPassword': 'string',
                                        'HAPairs': 123,
                                        'ThroughputCapacityPerHAPair': 123,
                                        'EndpointIpv6AddressRange': 'string'
                                    },
                                    'FileSystemTypeVersion': 'string',
                                    'OpenZFSConfiguration': {
                                        'AutomaticBackupRetentionDays': 123,
                                        'CopyTagsToBackups': True|False,
                                        'CopyTagsToVolumes': True|False,
                                        'DailyAutomaticBackupStartTime': 'string',
                                        'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1',
                                        'ThroughputCapacity': 123,
                                        'WeeklyMaintenanceStartTime': 'string',
                                        'DiskIopsConfiguration': {
                                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                                            'Iops': 123
                                        },
                                        'RootVolumeId': 'string',
                                        'PreferredSubnetId': 'string',
                                        'EndpointIpAddressRange': 'string',
                                        'EndpointIpv6AddressRange': 'string',
                                        'RouteTableIds': [
                                            'string',
                                        ],
                                        'EndpointIpAddress': 'string',
                                        'EndpointIpv6Address': 'string',
                                        'ReadCacheConfiguration': {
                                            'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                                            'SizeGiB': 123
                                        }
                                    },
                                    'NetworkType': 'IPV4'|'DUAL'
                                },
                                'FailureDetails': {
                                    'Message': 'string'
                                },
                                'TargetVolumeValues': {'... recursive ...'},
                                'TargetSnapshotValues': {
                                    'ResourceARN': 'string',
                                    'SnapshotId': 'string',
                                    'Name': 'string',
                                    'VolumeId': 'string',
                                    'CreationTime': datetime(2015, 1, 1),
                                    'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE',
                                    'LifecycleTransitionReason': {
                                        'Message': 'string'
                                    },
                                    'Tags': [
                                        {
                                            'Key': 'string',
                                            'Value': 'string'
                                        },
                                    ],
                                    'AdministrativeActions': {'... recursive ...'}
                                },
                                'TotalTransferBytes': 123,
                                'RemainingTransferBytes': 123,
                                'Message': 'string'
                            },
                        ],
                        'OpenZFSConfiguration': {
                            'ParentVolumeId': 'string',
                            'VolumePath': 'string',
                            'StorageCapacityReservationGiB': 123,
                            'StorageCapacityQuotaGiB': 123,
                            'RecordSizeKiB': 123,
                            'DataCompressionType': 'NONE'|'ZSTD'|'LZ4',
                            'CopyTagsToSnapshots': True|False,
                            'OriginSnapshot': {
                                'SnapshotARN': 'string',
                                'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                            },
                            'ReadOnly': True|False,
                            'NfsExports': [
                                {
                                    'ClientConfigurations': [
                                        {
                                            'Clients': 'string',
                                            'Options': [
                                                'string',
                                            ]
                                        },
                                    ]
                                },
                            ],
                            'UserAndGroupQuotas': [
                                {
                                    'Type': 'USER'|'GROUP',
                                    'Id': 123,
                                    'StorageCapacityQuotaGiB': 123
                                },
                            ],
                            'RestoreToSnapshot': 'string',
                            'DeleteIntermediateSnaphots': True|False,
                            'DeleteClonedVolumes': True|False,
                            'DeleteIntermediateData': True|False,
                            'SourceSnapshotARN': 'string',
                            'DestinationSnapshot': 'string',
                            'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                        }
                    },
                    'SizeInBytes': 123
                },
            ],
            
        }
        

    **Response Structure**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups>`_


    