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

UpdateBillingTransferPreference

Sets the auto billing group creation preference for a billing transfer. When the preference is enabled, AWS Billing Conductor automatically creates an indirect billing transfer billing group in your account, with the pricing plan that you specify, for each account that transfers its bill to the bill source account of this billing transfer. The preference applies only to billing groups that are created after you enable it.

Enabling the preference requires the iam:CreateServiceLinkedRole permission. While a pricing plan is specified in an enabled preference, you can't delete that pricing plan.

Request Syntax


PUT /update-billing-transfer-preference HTTP/1.1
X-Amzn-Client-Token: ClientToken
Content-type: application/json

{
   "AutoBillingTransferBillingGroupCreation": { 
      "Enabled": boolean,
      "PricingPlanArn": "string"
   },
   "ResponsibilityTransferArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ClientToken

A unique, case-sensitive identifier that you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Request Body

The request accepts the following data in JSON format.

AutoBillingTransferBillingGroupCreation

The auto billing group creation preference to set for the billing transfer.

Type: AutoTransferBillingGroupCreationPreference object

Required: Yes

ResponsibilityTransferArn

The Amazon Resource Name (ARN) of the billing transfer whose preference you want to set.

Type: String

Pattern: arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\d{12}:transfer/o-[a-z0-9]{10,32}/(billing)/(inbound|outbound)/rt-[0-9a-z]{8,32}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AutoBillingTransferBillingGroupCreation": { 
      "Enabled": boolean,
      "PricingPlanArn": "string"
   },
   "LastModifiedTime": number,
   "ResponsibilityTransferArn": "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.

AutoBillingTransferBillingGroupCreation

The updated auto billing group creation preference for the billing transfer.

Type: AutoTransferBillingGroupCreationPreference object

LastModifiedTime

The most recent time when the preference was modified.

Type: Long

ResponsibilityTransferArn

The Amazon Resource Name (ARN) of the billing transfer that the preference applies to.

Type: String

Pattern: arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\d{12}:transfer/o-[a-z0-9]{10,32}/(billing)/(inbound|outbound)/rt-[0-9a-z]{8,32}

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

You can cause an inconsistent state by updating or deleting a resource.

Reason: Reason for the inconsistent state.
ResourceId: Identifier of the resource in use.
ResourceType: Type of the resource in use.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

RetryAfterSeconds: Number of seconds you can retry after the call.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

ResourceId: Resource identifier that was not found.
ResourceType: Resource type that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds: Number of seconds you can safely retry after the call.

HTTP Status Code: 429

ValidationException

The input doesn't match with the constraints specified by AWS services.

Fields: The fields that caused the error, if applicable.
Reason: The reason the request's validation failed.

HTTP Status Code: 400