ResourceGroups / Client / update_account_settings

update_account_settings#

ResourceGroups.Client.update_account_settings(**kwargs)#

Turns on or turns off optional features in Resource Groups.

The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

Request Syntax

response = client.update_account_settings(
    GroupLifecycleEventsDesiredStatus='ACTIVE'|'INACTIVE'
)

Parameters:

GroupLifecycleEventsDesiredStatus (string) – Specifies whether you want to turn group lifecycle events on or off.

Return type:

dict

Returns:

Response Syntax

{
    'AccountSettings': {
        'GroupLifecycleEventsDesiredStatus': 'ACTIVE'|'INACTIVE',
        'GroupLifecycleEventsStatus': 'ACTIVE'|'INACTIVE'|'IN_PROGRESS'|'ERROR',
        'GroupLifecycleEventsStatusMessage': 'string'
    }
}

Response Structure

(dict) –
- AccountSettings (dict) –
  
  A structure that displays the status of the optional features in the account.
  - GroupLifecycleEventsDesiredStatus (string) –
    
    The desired target status of the group lifecycle events feature. If
  - GroupLifecycleEventsStatus (string) –
    
    The current status of the group lifecycle events feature.
  - GroupLifecycleEventsStatusMessage (string) –
    
    The text of any error message occurs during an attempt to turn group lifecycle events on or off.

Exceptions

ResourceGroups.Client.exceptions.BadRequestException
ResourceGroups.Client.exceptions.ForbiddenException
ResourceGroups.Client.exceptions.MethodNotAllowedException
ResourceGroups.Client.exceptions.TooManyRequestsException
ResourceGroups.Client.exceptions.InternalServerErrorException