CloudTrail / Client / disable_federation

disable_federation#

CloudTrail.Client.disable_federation(**kwargs)#

Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail removes the metadata associated with the federated event data store in the Glue Data Catalog and removes registration for the federation role ARN and event data store in Lake Formation. No CloudTrail Lake data is deleted when you disable federation.

Request Syntax

response = client.disable_federation(
    EventDataStore='string'
)

Parameters:

EventDataStore (string) –

[REQUIRED]

The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.

Return type:

dict

Returns:

Response Syntax

{
    'EventDataStoreArn': 'string',
    'FederationStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}

Response Structure

(dict) –
- EventDataStoreArn (string) –
  
  The ARN of the event data store for which you disabled Lake query federation.
- FederationStatus (string) –
  
  The federation status.

Exceptions

CloudTrail.Client.exceptions.EventDataStoreARNInvalidException
CloudTrail.Client.exceptions.EventDataStoreNotFoundException
CloudTrail.Client.exceptions.InvalidParameterException
CloudTrail.Client.exceptions.InactiveEventDataStoreException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.CloudTrailAccessNotEnabledException
CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException
CloudTrail.Client.exceptions.NotOrganizationMasterAccountException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException
CloudTrail.Client.exceptions.OrganizationsNotInUseException
CloudTrail.Client.exceptions.OrganizationNotInAllFeaturesModeException
CloudTrail.Client.exceptions.ConcurrentModificationException
CloudTrail.Client.exceptions.AccessDeniedException