Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateAccountSettings

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


POST /update-account-settings HTTP/1.1
Content-type: application/json

{
   "GroupLifecycleEventsDesiredStatus": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GroupLifecycleEventsDesiredStatus

Specifies whether you want to turn group lifecycle events on or off.

You can't enable group lifecycle events if your resource groups quota is greater than 2,000.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountSettings": { 
      "GroupLifecycleEventsDesiredStatus": "string",
      "GroupLifecycleEventsStatus": "string",
      "GroupLifecycleEventsStatusMessage": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountSettings

A structure that displays the status of the optional features in the account.

Type: AccountSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The request includes one or more parameters that violate validation rules.

HTTP Status Code: 400

ForbiddenException

The caller isn't authorized to make the request. Check permissions.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request. Try again later.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method that isn't allowed for the specified resource.

HTTP Status Code: 405

TooManyRequestsException

You've exceeded throttling limits by making too many requests in a period of time.

HTTP Status Code: 429

Examples

Example

The following example turns on the group lifecycle events setting for the calling Amazon Web Services account:

Sample Request


POST /update-account-settings HTTP/1.1
Host: resource-groups.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: <VARIES>
X-Amz-Date: 20221213T215349Z
X-Amz-Security-Token: <SECURITY-TOKEN>
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS-KEY>/20220113/us-west-2/resource-groups/aws4_request,SignedHeaders=host;x-amz-date;x-amz-security-token,Signature=<SIGV4-SIGNATURE>
Content-Length: 47

{
    "GroupLifecycleEventsDesiredStatus": "ACTIVE"
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 13 Dec 2022 21:53:49 GMT
Content-Type: application/json
Content-Length: 109
x-amzn-RequestId: <VARIES>
x-amz-apigw-id: <VARIES>
X-Amzn-Trace-Id: Root=<VARIES>
Connection: keep-alive

{
    "AccountSettings": {
        "GroupLifecycleEventsDesiredStatus": "ACTIVE",
        "GroupLifecycleEventsStatus": "IN_PROGRESS"
    }
}