View a markdown version of this page

GetBillingTransferPreference - AWS Billing Conductor

GetBillingTransferPreference

Retrieves the auto billing group creation preference for a billing transfer.

Request Syntax

POST /get-billing-transfer-preference HTTP/1.1 Content-type: application/json { "ResponsibilityTransferArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ResponsibilityTransferArn

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

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 auto billing group creation preference for the billing transfer.

Type: AutoTransferBillingGroupCreationPreference object

LastModifiedTime

The most recent time when the preference was modified. This value is empty if the preference has never been set for the billing transfer.

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

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

See Also

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