View a markdown version of this page

PutAccountProperties - AWS Identity and Access Management

PutAccountProperties

Sets account-level properties for the caller's AWS account. Account properties are configuration settings that control account-wide IAM features such as Role Manager.

Specify properties as key-value pairs in Namespace/PropertyName format. All properties in a single request must belong to the same namespace. Use GetAccountProperties to view the current properties.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Properties
Properties.entry.N.key (key)
Properties.entry.N.value (value)

A map of property key-value pairs to set. All keys must belong to the same namespace.

Each key uses the format Namespace/PropertyName. The key must contain exactly one / separating the namespace from the property name, and cannot start or end with /.

The service validates each value based on the property key's expected type. For example, boolean properties expect true or false.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Key Pattern: ^[A-Za-z][A-Za-z0-9/_-]*$

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

Errors

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

ConcurrentModification

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

HTTP Status Code: 409

InvalidInput

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

ServiceFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples

Enable Role Manager

This example enables the Role Manager feature for the calling account.

Sample Request

https://iam.amazonaws.com/?Action=PutAccountProperties &Properties.entry.1.key=RoleManager/Enabled &Properties.entry.1.value=true &Version=2010-05-08 &AUTHPARAMS

Sample Response

<PutAccountPropertiesResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <ResponseMetadata> <RequestId>3a4c2b1d-5e6f-7890-abcd-1234EXAMPLE</RequestId> </ResponseMetadata> </PutAccountPropertiesResponse>

Disable Role Manager

This example illustrates one usage of PutAccountProperties.

Sample Request

https://iam.amazonaws.com/?Action=PutAccountProperties &Properties.entry.1.key=RoleManager/Enabled &Properties.entry.1.value=false &Version=2010-05-08 &AUTHPARAMS

Sample Response

<PutAccountPropertiesResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> </PutAccountPropertiesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: