1/18/2019 account:update - Amazon API Gateway API Reference

 Amazon API Gateway REST API Reference

REST API Reference > Link Relations > account:update

account:update
Changes information about the associated Account resource.

HTTP Request

PATCH /account

Request Body

{
"patchOperations" : [ {
"op" : "String",
"path" : "String",
"value" : "String",
"from" : "String"
} ]
}

Request Body Fields

The request accepts the following fields in JSON format.

patchOperations

A list of update operations to be applied to the specified resource and in the order specified in
this list.

op

An update operation to be performed with this PATCH request. The valid value can be
add, remove, replace or copy. Not all valid operations are supported for a given resource.
Support of the operations depends on specific operational contexts. Attempts to apply an
unsupported operation on a resource will return an error message.

We use cookies
pathto provide and improve our services. By using our site, you consent to cookies. Learn More

https://docs.aws.amazon.com/apigateway/api-reference/link-relation/account-update/ 1/4
1/18/2019 account:update - Amazon API Gateway API Reference

The op operation's target, as identified by a JSON Pointer value that references a

location within the targeted resource. For example, if the target resource has an
updateable property of {"name":"value"}, the path for this property is /name. If the name
property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the
path for the child/name property will be /name/child~1name. Any slash ("/") character
appearing in path names must be escaped with "~1", as shown in the example above.
Each op operation can have only one path associated with it.

value

The new target value of the update operation. It is applicable for the add or replace
operation. When using AWS CLI to update a property of a JSON value, enclose the
JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows
shell, see Using JSON for Parameters.

from

The copy update operation's source as identified by a JSON-Pointer value referencing

the location within the targeted resource to copy the value from. For example, to
promote a canary deployment, you copy the canary deployment ID to the affiliated
deployment ID by calling a PATCH request on a Stage resource with "op":"copy",
"from":"/canarySettings/deploymentId" and "path":"/deploymentId".

Response

Account

Remarks

The following table shows the supported and unsupported op operations for updateable Account
properties of the specified path values.

path op:add op:replace op:remove op:copy

/cloudwatchRoleArn Not supported Supported Not supported Not supported

Supported, but not

/features Supported Not supported for the UsagePlans Not supported
feature.

Valid values for /features and cloudWatchRoleArn are UsagePlans and an IAM role ARN,
We use cookies to provide and improve our services. By using our site, you consent to cookies. Learn More
respectively.

https://docs.aws.amazon.com/apigateway/api-reference/link-relation/account-update/ 2/4
1/18/2019 account:update - Amazon API Gateway API Reference

Errors code

The following exception may be thrown when the request fails.

UnauthorizedException
BadRequestException
NotFoundException
TooManyRequestsException

For details of the error codes, see API Gateway Error Codes.

Example: Update an Account's CloudWatch role

Request

The following example updates an account's CloudWatch role ARN by replacing the existing one
with a new CloudWatch role ARN.

PATCH /account HTTP/1.1

Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160531T212738Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160531/us-east-1/apigateway/aws

{
"patchOperations" : [{
"op" : "replace",
"path" : "/cloudwatchRoleArn",
"value" : "arn:aws:iam::123456789012:role/apigAwsProxyRole"
}]
}

Response

The following example response shows a successful result:

{
"_links": {
"curies": {
"href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-ap
"name": "account",
"templated": true
},
"self": {
"href": "/account"
We use cookies},to provide and improve our services. By using our site, you consent to cookies. Learn More
"account:update": {

https://docs.aws.amazon.com/apigateway/api-reference/link-relation/account-update/ 3/4
1/18/2019 account:update - Amazon API Gateway API Reference

"href": "/account"
}
},
"cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
"throttleSettings": {
"rateLimit": 500,
"burstLimit": 1000
}
}

If you specify an invalid role, i.e., a role that does not permit API Gateway to invoke CloudWatch
logs, you will receive an error response. If you attempt to replace the throttleSettings, in part or
as a whole, you will receive 400 Bad Request response with an error message stating that
/throttleSettings value cannot be changed this way, but the /cloudwatchRoleArn value can.

See Also

AWS CLI, AWS SDKs

© 2018, Amazon Web Services, Inc. or its affiliates. All rights reserved. Return to top. Feedback

We use cookies to provide and improve our services. By using our site, you consent to cookies. Learn More

https://docs.aws.amazon.com/apigateway/api-reference/link-relation/account-update/ 4/4