UpdateAccountPool
Updates the account pool.
Request Syntax
PATCH /v2/domains/domainIdentifier/account-pools/identifier HTTP/1.1
Content-type: application/json
{
"accountSource": { ... },
"description": "string",
"name": "string",
"resolutionStrategy": "string"
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The domain ID where the account pool that is to be updated lives.
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36}Required: Yes
- identifier
-
The ID of the account pool that is to be updated.
Pattern:
[a-zA-Z0-9_-]{1,36}Required: Yes
Request Body
The request accepts the following data in JSON format.
- accountSource
-
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.
Type: AccountSource object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- description
-
The description of the account pool that is to be udpated.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- name
-
The name of the account pool that is to be updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w -]+Required: No
- resolutionStrategy
-
The mechanism used to resolve the account selection from the account pool.
Type: String
Valid Values:
MANUALRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accountSource": { ... },
"createdAt": "string",
"createdBy": "string",
"description": "string",
"domainId": "string",
"domainUnitId": "string",
"id": "string",
"lastUpdatedAt": "string",
"name": "string",
"resolutionStrategy": "string",
"updatedBy": "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.
- accountSource
-
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.
Type: AccountSource object
Note: This object is a Union. Only one member of this object can be specified or returned.
- createdAt
-
The timestamp at which the account pool was created.
Type: Timestamp
- createdBy
-
The user who created the account pool.
Type: String
- description
-
The description of the account pool that is to be udpated.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The domain ID where the account pool that is to be updated lives.
Type: String
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36} - domainUnitId
-
The domain ID in which the account pool that is to be updated lives.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-z0-9_\-]+ - id
-
The ID of the account pool that is to be updated.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - lastUpdatedAt
-
The timestamp at which the account pool was last updated.
Type: Timestamp
- name
-
The name of the account pool that is to be updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w -]+ - resolutionStrategy
-
The mechanism used to resolve the account selection from the account pool.
Type: String
Valid Values:
MANUAL - updatedBy
-
The user who last updated the account pool.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There is a conflict while performing this action.
HTTP Status Code: 409
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request has exceeded the specified service quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
