# Actions The following actions are supported: + [AssociateAccounts](API_AssociateAccounts.md) + [AssociatePricingRules](API_AssociatePricingRules.md) + [BatchAssociateResourcesToCustomLineItem](API_BatchAssociateResourcesToCustomLineItem.md) + [BatchDisassociateResourcesFromCustomLineItem](API_BatchDisassociateResourcesFromCustomLineItem.md) + [CreateBillingGroup](API_CreateBillingGroup.md) + [CreateCustomLineItem](API_CreateCustomLineItem.md) + [CreatePricingPlan](API_CreatePricingPlan.md) + [CreatePricingRule](API_CreatePricingRule.md) + [DeleteBillingGroup](API_DeleteBillingGroup.md) + [DeleteCustomLineItem](API_DeleteCustomLineItem.md) + [DeletePricingPlan](API_DeletePricingPlan.md) + [DeletePricingRule](API_DeletePricingRule.md) + [DisassociateAccounts](API_DisassociateAccounts.md) + [DisassociatePricingRules](API_DisassociatePricingRules.md) + [GetBillingGroupCostReport](API_GetBillingGroupCostReport.md) + [ListAccountAssociations](API_ListAccountAssociations.md) + [ListBillingGroupCostReports](API_ListBillingGroupCostReports.md) + [ListBillingGroups](API_ListBillingGroups.md) + [ListCustomLineItems](API_ListCustomLineItems.md) + [ListCustomLineItemVersions](API_ListCustomLineItemVersions.md) + [ListPricingPlans](API_ListPricingPlans.md) + [ListPricingPlansAssociatedWithPricingRule](API_ListPricingPlansAssociatedWithPricingRule.md) + [ListPricingRules](API_ListPricingRules.md) + [ListPricingRulesAssociatedToPricingPlan](API_ListPricingRulesAssociatedToPricingPlan.md) + [ListResourcesAssociatedToCustomLineItem](API_ListResourcesAssociatedToCustomLineItem.md) + [ListTagsForResource](API_ListTagsForResource.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateBillingGroup](API_UpdateBillingGroup.md) + [UpdateCustomLineItem](API_UpdateCustomLineItem.md) + [UpdatePricingPlan](API_UpdatePricingPlan.md) + [UpdatePricingRule](API_UpdatePricingRule.md) # AssociateAccounts Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30. ## Request Syntax ``` POST /associate-accounts HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AccountIds](#API_AssociateAccounts_RequestSyntax) ** The associating array of account IDs. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 30 items. Pattern: `[0-9]{12}` Required: Yes ** [Arn](#API_AssociateAccounts_RequestSyntax) ** The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_AssociateAccounts_ResponseSyntax) ** The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/AssociateAccounts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/AssociateAccounts) # AssociatePricingRules Connects an array of `PricingRuleArns` to a defined `PricingPlan`. The maximum number `PricingRuleArn` that can be associated in one call is 30. ## Request Syntax ``` PUT /associate-pricing-rules HTTP/1.1 Content-type: application/json { "Arn": "string", "PricingRuleArns": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_AssociatePricingRules_RequestSyntax) ** The `PricingPlanArn` that the `PricingRuleArns` are associated with. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` Required: Yes ** [PricingRuleArns](#API_AssociatePricingRules_RequestSyntax) ** The `PricingRuleArns` that are associated with the Pricing Plan. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_AssociatePricingRules_ResponseSyntax) ** The `PricingPlanArn` that the `PricingRuleArns` are associated with. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/AssociatePricingRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/AssociatePricingRules) # BatchAssociateResourcesToCustomLineItem Associates a batch of resources to a percentage custom line item. ## Request Syntax ``` PUT /batch-associate-resources-to-custom-line-item HTTP/1.1 Content-type: application/json { "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" }, "ResourceArns": [ "string" ], "TargetArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriodRange](#API_BatchAssociateResourcesToCustomLineItem_RequestSyntax) ** The billing period range in which the custom line item request will be applied. Type: [CustomLineItemBillingPeriodRange](API_CustomLineItemBillingPeriodRange.md) object Required: No ** [ResourceArns](#API_BatchAssociateResourcesToCustomLineItem_RequestSyntax) ** A list containing the ARNs of the resources to be associated. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}` Required: Yes ** [TargetArn](#API_BatchAssociateResourcesToCustomLineItem_RequestSyntax) ** A percentage custom line item ARN to associate the resources to. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "FailedAssociatedResources": [ { "Arn": "string", "Error": { "Message": "string", "Reason": "string" } } ], "SuccessfullyAssociatedResources": [ { "Arn": "string", "Error": { "Message": "string", "Reason": "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. ** [FailedAssociatedResources](#API_BatchAssociateResourcesToCustomLineItem_ResponseSyntax) ** A list of `AssociateResourceResponseElement` for each resource that failed association to a percentage custom line item. Type: Array of [AssociateResourceResponseElement](API_AssociateResourceResponseElement.md) objects ** [SuccessfullyAssociatedResources](#API_BatchAssociateResourcesToCustomLineItem_ResponseSyntax) ** A list of `AssociateResourceResponseElement` for each resource that's been associated to a percentage custom line item successfully. Type: Array of [AssociateResourceResponseElement](API_AssociateResourceResponseElement.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/BatchAssociateResourcesToCustomLineItem) # BatchDisassociateResourcesFromCustomLineItem Disassociates a batch of resources from a percentage custom line item. ## Request Syntax ``` PUT /batch-disassociate-resources-from-custom-line-item HTTP/1.1 Content-type: application/json { "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" }, "ResourceArns": [ "string" ], "TargetArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriodRange](#API_BatchDisassociateResourcesFromCustomLineItem_RequestSyntax) ** The billing period range in which the custom line item request will be applied. Type: [CustomLineItemBillingPeriodRange](API_CustomLineItemBillingPeriodRange.md) object Required: No ** [ResourceArns](#API_BatchDisassociateResourcesFromCustomLineItem_RequestSyntax) ** A list containing the ARNs of resources to be disassociated. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:(customlineitem|billinggroup)/)?[a-zA-Z0-9]{10,12}` Required: Yes ** [TargetArn](#API_BatchDisassociateResourcesFromCustomLineItem_RequestSyntax) ** A percentage custom line item ARN to disassociate the resources from. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "FailedDisassociatedResources": [ { "Arn": "string", "Error": { "Message": "string", "Reason": "string" } } ], "SuccessfullyDisassociatedResources": [ { "Arn": "string", "Error": { "Message": "string", "Reason": "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. ** [FailedDisassociatedResources](#API_BatchDisassociateResourcesFromCustomLineItem_ResponseSyntax) ** A list of `DisassociateResourceResponseElement` for each resource that failed disassociation from a percentage custom line item. Type: Array of [DisassociateResourceResponseElement](API_DisassociateResourceResponseElement.md) objects ** [SuccessfullyDisassociatedResources](#API_BatchDisassociateResourcesFromCustomLineItem_ResponseSyntax) ** A list of `DisassociateResourceResponseElement` for each resource that's been disassociated from a percentage custom line item successfully. Type: Array of [DisassociateResourceResponseElement](API_DisassociateResourceResponseElement.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/BatchDisassociateResourcesFromCustomLineItem) # CreateBillingGroup Creates a billing group that resembles a consolidated billing family that AWS charges, based off of the predefined pricing plan computation. ## Request Syntax ``` POST /create-billing-group HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "AccountGrouping": { "AutoAssociate": boolean, "LinkedAccountIds": [ "string" ], "ResponsibilityTransferArn": "string" }, "ComputationPreference": { "PricingPlanArn": "string" }, "Description": "string", "Name": "string", "PrimaryAccountId": "string", "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ClientToken](#API_CreateBillingGroup_RequestSyntax) ** 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. ** [AccountGrouping](#API_CreateBillingGroup_RequestSyntax) ** The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family. Type: [AccountGrouping](API_AccountGrouping.md) object Required: Yes ** [ComputationPreference](#API_CreateBillingGroup_RequestSyntax) ** The preferences and settings that will be used to compute the AWS charges for a billing group. Type: [ComputationPreference](API_ComputationPreference.md) object Required: Yes ** [Description](#API_CreateBillingGroup_RequestSyntax) ** The description of the billing group. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [Name](#API_CreateBillingGroup_RequestSyntax) ** The billing group name. The names must be unique. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: Yes ** [PrimaryAccountId](#API_CreateBillingGroup_RequestSyntax) ** The account ID that serves as the main account in a billing group. Type: String Pattern: `[0-9]{12}` Required: No ** [Tags](#API_CreateBillingGroup_RequestSyntax) ** A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_CreateBillingGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created billing group. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/CreateBillingGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/CreateBillingGroup) # CreateCustomLineItem Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount. ## Request Syntax ``` POST /create-custom-line-item HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "AccountId": "string", "BillingGroupArn": "string", "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" }, "ChargeDetails": { "Flat": { "ChargeValue": number }, "LineItemFilters": [ { "Attribute": "string", "AttributeValues": [ "string" ], "MatchOption": "string", "Values": [ "string" ] } ], "Percentage": { "AssociatedValues": [ "string" ], "PercentageValue": number }, "Type": "string" }, "ComputationRule": "string", "Description": "string", "Name": "string", "PresentationDetails": { "Service": "string" }, "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ClientToken](#API_CreateCustomLineItem_RequestSyntax) ** 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. ** [AccountId](#API_CreateCustomLineItem_RequestSyntax) ** The AWS account in which this custom line item will be applied to. Type: String Pattern: `[0-9]{12}` Required: No ** [BillingGroupArn](#API_CreateCustomLineItem_RequestSyntax) ** The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ** [BillingPeriodRange](#API_CreateCustomLineItem_RequestSyntax) ** A time range for which the custom line item is effective. Type: [CustomLineItemBillingPeriodRange](API_CustomLineItemBillingPeriodRange.md) object Required: No ** [ChargeDetails](#API_CreateCustomLineItem_RequestSyntax) ** A `CustomLineItemChargeDetails` that describes the charge details for a custom line item. Type: [CustomLineItemChargeDetails](API_CustomLineItemChargeDetails.md) object Required: Yes ** [ComputationRule](#API_CreateCustomLineItem_RequestSyntax) ** Specifies how the custom line item charges are computed. Type: String Valid Values: `ITEMIZED | CONSOLIDATED` Required: No ** [Description](#API_CreateCustomLineItem_RequestSyntax) ** The description of the custom line item. This is shown on the Bills page in association with the charge value. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [Name](#API_CreateCustomLineItem_RequestSyntax) ** The name of the custom line item. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: Yes ** [PresentationDetails](#API_CreateCustomLineItem_RequestSyntax) ** Details controlling how the custom line item charges are presented in the bill. Contains specifications for which service the charges will be shown under. Type: [PresentationObject](API_PresentationObject.md) object Required: No ** [Tags](#API_CreateCustomLineItem_RequestSyntax) ** A map that contains tag keys and tag values that are attached to a custom line item. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_CreateCustomLineItem_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created custom line item. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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 ## Examples ### The following example applies a custom line item to another linked account (555555555555) in the billing group. This example illustrates one usage of CreateCustomLineItem. #### Sample Request ``` POST /create-custom-line-item HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "BillingGroupArn": "arn:aws:billingconductor::123456789012:billinggroup/111122223333", "ChargeDetails": { "Flat": { "ChargeValue":10 }, "Type": "FEE" }, "Description": "My custom line item", "Name": "MyCustomLineItem", "AccountId": "555555555555" } ``` #### Sample Response ``` HTTP/1.1 200 Content-type: application/json { "Arn": "arn:aws:billingconductor::123456789012:customlineitem/555555555555" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/CreateCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/CreateCustomLineItem) # CreatePricingPlan Creates a pricing plan that is used for computing AWS charges for billing groups. ## Request Syntax ``` POST /create-pricing-plan HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "Description": "string", "Name": "string", "PricingRuleArns": [ "string" ], "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ClientToken](#API_CreatePricingPlan_RequestSyntax) ** 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. ** [Description](#API_CreatePricingPlan_RequestSyntax) ** The description of the pricing plan. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [Name](#API_CreatePricingPlan_RequestSyntax) ** The name of the pricing plan. The names must be unique to each pricing plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: Yes ** [PricingRuleArns](#API_CreatePricingPlan_RequestSyntax) ** A list of Amazon Resource Names (ARNs) that define the pricing plan parameters. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 30 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: No ** [Tags](#API_CreatePricingPlan_RequestSyntax) ** A map that contains tag keys and tag values that are attached to a pricing plan. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_CreatePricingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created pricing plan. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/CreatePricingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/CreatePricingPlan) # CreatePricingRule Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans. ## Request Syntax ``` POST /create-pricing-rule HTTP/1.1 X-Amzn-Client-Token: ClientToken Content-type: application/json { "BillingEntity": "string", "Description": "string", "ModifierPercentage": number, "Name": "string", "Operation": "string", "Scope": "string", "Service": "string", "Tags": { "string" : "string" }, "Tiering": { "FreeTier": { "Activated": boolean } }, "Type": "string", "UsageType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ClientToken](#API_CreatePricingRule_RequestSyntax) ** 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. ** [BillingEntity](#API_CreatePricingRule_RequestSyntax) ** The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplace. Type: String Pattern: `[a-zA-Z0-9() ]+` Required: No ** [Description](#API_CreatePricingRule_RequestSyntax) ** The pricing rule description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [ModifierPercentage](#API_CreatePricingRule_RequestSyntax) ** A percentage modifier that's applied on the public pricing rates. Your entry will be rounded to the nearest 2 decimal places. Type: Double Valid Range: Minimum value of 0. Required: No ** [Name](#API_CreatePricingRule_RequestSyntax) ** The pricing rule name. The names must be unique to each pricing rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: Yes ** [Operation](#API_CreatePricingRule_RequestSyntax) ** Operation is the specific AWS action covered by this line item. This describes the specific usage of the line item. If the `Scope` attribute is set to `SKU`, this attribute indicates which operation the `PricingRule` is modifying. For example, a value of `RunInstances:0202` indicates the operation of running an Amazon EC2 instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` Required: No ** [Scope](#API_CreatePricingRule_RequestSyntax) ** The scope of pricing rule that indicates if it's globally applicable, or it's service-specific. Type: String Valid Values: `GLOBAL | SERVICE | BILLING_ENTITY | SKU` Required: Yes ** [Service](#API_CreatePricingRule_RequestSyntax) ** If the `Scope` attribute is set to `SERVICE` or `SKU`, the attribute indicates which service the `PricingRule` is applicable for. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9]+` Required: No ** [Tags](#API_CreatePricingRule_RequestSyntax) ** A map that contains tag keys and tag values that are attached to a pricing rule. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [Tiering](#API_CreatePricingRule_RequestSyntax) ** The set of tiering configurations for the pricing rule. Type: [CreateTieringInput](API_CreateTieringInput.md) object Required: No ** [Type](#API_CreatePricingRule_RequestSyntax) ** The type of pricing rule. Type: String Valid Values: `MARKUP | DISCOUNT | TIERING` Required: Yes ** [UsageType](#API_CreatePricingRule_RequestSyntax) ** Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the `Scope` attribute is set to `SKU`, this attribute indicates which usage type the `PricingRule` is modifying. For example, `USW2-BoxUsage:m2.2xlarge` describes an` M2 High Memory Double Extra Large` instance in the US West (Oregon) Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_CreatePricingRule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the created pricing rule. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ServiceLimitExceededException ** The request would cause a service limit to exceed. ** LimitCode ** The unique code identifier of the service limit that is being exceeded. ** ResourceId ** Identifier of the resource affected. ** ResourceType ** Type of the resource affected. ** ServiceCode ** The unique code for the service of the limit that is being exceeded. HTTP Status Code: 402 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/CreatePricingRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/CreatePricingRule) # DeleteBillingGroup Deletes a billing group. ## Request Syntax ``` POST /delete-billing-group HTTP/1.1 Content-type: application/json { "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_DeleteBillingGroup_RequestSyntax) ** The Amazon Resource Name (ARN) of the billing group that you're deleting. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DeleteBillingGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the deleted billing group. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DeleteBillingGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DeleteBillingGroup) # DeleteCustomLineItem Deletes the custom line item identified by the given ARN in the current, or previous billing period. ## Request Syntax ``` POST /delete-custom-line-item HTTP/1.1 Content-type: application/json { "Arn": "string", "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_DeleteCustomLineItem_RequestSyntax) ** The ARN of the custom line item to be deleted. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ** [BillingPeriodRange](#API_DeleteCustomLineItem_RequestSyntax) ** The billing period range in which the custom line item request will be applied. Type: [CustomLineItemBillingPeriodRange](API_CustomLineItemBillingPeriodRange.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DeleteCustomLineItem_ResponseSyntax) ** The ARN of the deleted custom line item. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DeleteCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DeleteCustomLineItem) # DeletePricingPlan Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully. ## Request Syntax ``` POST /delete-pricing-plan HTTP/1.1 Content-type: application/json { "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_DeletePricingPlan_RequestSyntax) ** The Amazon Resource Name (ARN) of the pricing plan that you're deleting. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DeletePricingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN) of the deleted pricing plan. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DeletePricingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DeletePricingPlan) # DeletePricingRule Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN). ## Request Syntax ``` POST /delete-pricing-rule HTTP/1.1 Content-type: application/json { "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_DeletePricingRule_RequestSyntax) ** The Amazon Resource Name (ARN) of the pricing rule that you are deleting. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DeletePricingRule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the deleted pricing rule. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DeletePricingRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DeletePricingRule) # DisassociateAccounts Removes the specified list of account IDs from the given billing group. ## Request Syntax ``` POST /disassociate-accounts HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "Arn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AccountIds](#API_DisassociateAccounts_RequestSyntax) ** The array of account IDs to disassociate. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 30 items. Pattern: `[0-9]{12}` Required: Yes ** [Arn](#API_DisassociateAccounts_RequestSyntax) ** The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DisassociateAccounts_ResponseSyntax) ** The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DisassociateAccounts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DisassociateAccounts) # DisassociatePricingRules Disassociates a list of pricing rules from a pricing plan. ## Request Syntax ``` PUT /disassociate-pricing-rules HTTP/1.1 Content-type: application/json { "Arn": "string", "PricingRuleArns": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_DisassociatePricingRules_RequestSyntax) ** The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` Required: Yes ** [PricingRuleArns](#API_DisassociatePricingRules_RequestSyntax) ** A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "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. ** [Arn](#API_DisassociatePricingRules_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/DisassociatePricingRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/DisassociatePricingRules) # GetBillingGroupCostReport Retrieves the margin summary report, which includes the AWS cost and charged amount (pro forma cost) by AWS service for a specific billing group. ## Request Syntax ``` POST /get-billing-group-cost-report HTTP/1.1 Content-type: application/json { "Arn": "string", "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" }, "GroupBy": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_GetBillingGroupCostReport_RequestSyntax) ** The Amazon Resource Number (ARN) that uniquely identifies the billing group. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ** [BillingPeriodRange](#API_GetBillingGroupCostReport_RequestSyntax) ** A time range for which the margin summary is effective. You can specify up to 12 months. Type: [BillingPeriodRange](API_BillingPeriodRange.md) object Required: No ** [GroupBy](#API_GetBillingGroupCostReport_RequestSyntax) ** A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the AWS service name or the billing period. Type: Array of strings Valid Values: `PRODUCT_NAME | BILLING_PERIOD` Required: No ** [MaxResults](#API_GetBillingGroupCostReport_RequestSyntax) ** The maximum number of margin summary reports to retrieve. Type: Integer Valid Range: Minimum value of 200. Maximum value of 300. Required: No ** [NextToken](#API_GetBillingGroupCostReport_RequestSyntax) ** The pagination token used on subsequent calls to get reports. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingGroupCostReportResults": [ { "Arn": "string", "Attributes": [ { "Key": "string", "Value": "string" } ], "AWSCost": "string", "Currency": "string", "Margin": "string", "MarginPercentage": "string", "ProformaCost": "string" } ], "NextToken": "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. ** [BillingGroupCostReportResults](#API_GetBillingGroupCostReport_ResponseSyntax) ** The list of margin summary reports. Type: Array of [BillingGroupCostReportResultElement](API_BillingGroupCostReportResultElement.md) objects ** [NextToken](#API_GetBillingGroupCostReport_ResponseSyntax) ** The pagination token used on subsequent calls to get reports. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/GetBillingGroupCostReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/GetBillingGroupCostReport) # ListAccountAssociations This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account. ## Request Syntax ``` POST /list-account-associations HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "AccountId": "string", "AccountIds": [ "string" ], "Association": "string" }, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListAccountAssociations_RequestSyntax) ** The preferred billing period to get account associations. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListAccountAssociations_RequestSyntax) ** The filter on the account ID of the linked account, or any of the following: `MONITORED`: linked accounts that are associated to billing groups. `UNMONITORED`: linked accounts that aren't associated to billing groups. `Billing Group Arn`: linked accounts that are associated to the provided billing group Arn. Type: [ListAccountAssociationsFilter](API_ListAccountAssociationsFilter.md) object Required: No ** [NextToken](#API_ListAccountAssociations_RequestSyntax) ** The pagination token that's used on subsequent calls to retrieve accounts. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "LinkedAccounts": [ { "AccountEmail": "string", "AccountId": "string", "AccountName": "string", "BillingGroupArn": "string" } ], "NextToken": "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. ** [LinkedAccounts](#API_ListAccountAssociations_ResponseSyntax) ** The list of linked accounts in the payer account. Type: Array of [AccountAssociationsListElement](API_AccountAssociationsListElement.md) objects ** [NextToken](#API_ListAccountAssociations_ResponseSyntax) ** The pagination token that's used on subsequent calls to get accounts. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListAccountAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListAccountAssociations) # ListBillingGroupCostReports A paginated call to retrieve a summary report of actual AWS charges and the calculated AWS charges based on the associated pricing plan of a billing group. ## Request Syntax ``` POST /list-billing-group-cost-reports HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "BillingGroupArns": [ "string" ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListBillingGroupCostReports_RequestSyntax) ** The preferred billing period for your report. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListBillingGroupCostReports_RequestSyntax) ** A `ListBillingGroupCostReportsFilter` to specify billing groups to retrieve reports from. Type: [ListBillingGroupCostReportsFilter](API_ListBillingGroupCostReportsFilter.md) object Required: No ** [MaxResults](#API_ListBillingGroupCostReports_RequestSyntax) ** The maximum number of reports to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListBillingGroupCostReports_RequestSyntax) ** The pagination token that's used on subsequent calls to get reports. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingGroupCostReports": [ { "Arn": "string", "AWSCost": "string", "Currency": "string", "Margin": "string", "MarginPercentage": "string", "ProformaCost": "string" } ], "NextToken": "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. ** [BillingGroupCostReports](#API_ListBillingGroupCostReports_ResponseSyntax) ** A list of `BillingGroupCostReportElement` retrieved. Type: Array of [BillingGroupCostReportElement](API_BillingGroupCostReportElement.md) objects ** [NextToken](#API_ListBillingGroupCostReports_ResponseSyntax) ** The pagination token that's used on subsequent calls to get reports. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListBillingGroupCostReports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListBillingGroupCostReports) # ListBillingGroups A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used. ## Request Syntax ``` POST /list-billing-groups HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "Arns": [ "string" ], "AutoAssociate": boolean, "BillingGroupTypes": [ "string" ], "Names": [ { "SearchOption": "string", "SearchValue": "string" } ], "PricingPlan": "string", "PrimaryAccountIds": [ "string" ], "ResponsibilityTransferArns": [ "string" ], "Statuses": [ "string" ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListBillingGroups_RequestSyntax) ** The preferred billing period to get billing groups. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListBillingGroups_RequestSyntax) ** A `ListBillingGroupsFilter` that specifies the billing group and pricing plan to retrieve billing group information. Type: [ListBillingGroupsFilter](API_ListBillingGroupsFilter.md) object Required: No ** [MaxResults](#API_ListBillingGroups_RequestSyntax) ** The maximum number of billing groups to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListBillingGroups_RequestSyntax) ** The pagination token that's used on subsequent calls to get billing groups. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingGroups": [ { "AccountGrouping": { "AutoAssociate": boolean, "ResponsibilityTransferArn": "string" }, "Arn": "string", "BillingGroupType": "string", "ComputationPreference": { "PricingPlanArn": "string" }, "CreationTime": number, "Description": "string", "LastModifiedTime": number, "Name": "string", "PrimaryAccountId": "string", "Size": number, "Status": "string", "StatusReason": "string" } ], "NextToken": "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. ** [BillingGroups](#API_ListBillingGroups_ResponseSyntax) ** A list of `BillingGroupListElement` retrieved. Type: Array of [BillingGroupListElement](API_BillingGroupListElement.md) objects ** [NextToken](#API_ListBillingGroups_ResponseSyntax) ** The pagination token that's used on subsequent calls to get billing groups. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListBillingGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListBillingGroups) # ListCustomLineItems A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used. ## Request Syntax ``` POST /list-custom-line-items HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "AccountIds": [ "string" ], "Arns": [ "string" ], "BillingGroups": [ "string" ], "Names": [ "string" ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListCustomLineItems_RequestSyntax) ** The preferred billing period to get custom line items (FFLIs). Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListCustomLineItems_RequestSyntax) ** A `ListCustomLineItemsFilter` that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information. Type: [ListCustomLineItemsFilter](API_ListCustomLineItemsFilter.md) object Required: No ** [MaxResults](#API_ListCustomLineItems_RequestSyntax) ** The maximum number of billing groups to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListCustomLineItems_RequestSyntax) ** The pagination token that's used on subsequent calls to get custom line items (FFLIs). Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CustomLineItems": [ { "AccountId": "string", "Arn": "string", "AssociationSize": number, "BillingGroupArn": "string", "ChargeDetails": { "Flat": { "ChargeValue": number }, "LineItemFilters": [ { "Attribute": "string", "AttributeValues": [ "string" ], "MatchOption": "string", "Values": [ "string" ] } ], "Percentage": { "PercentageValue": number }, "Type": "string" }, "ComputationRule": "string", "CreationTime": number, "CurrencyCode": "string", "Description": "string", "LastModifiedTime": number, "Name": "string", "PresentationDetails": { "Service": "string" }, "ProductCode": "string" } ], "NextToken": "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. ** [CustomLineItems](#API_ListCustomLineItems_ResponseSyntax) ** A list of `FreeFormLineItemListElements` received. Type: Array of [CustomLineItemListElement](API_CustomLineItemListElement.md) objects ** [NextToken](#API_ListCustomLineItems_ResponseSyntax) ** The pagination token that's used on subsequent calls to get custom line items (FFLIs). Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListCustomLineItems) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListCustomLineItems) # ListCustomLineItemVersions A paginated call to get a list of all custom line item versions. ## Request Syntax ``` POST /list-custom-line-item-versions HTTP/1.1 Content-type: application/json { "Arn": "string", "Filters": { "BillingPeriodRange": { "EndBillingPeriod": "string", "StartBillingPeriod": "string" } }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_ListCustomLineItemVersions_RequestSyntax) ** The Amazon Resource Name (ARN) for the custom line item. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ** [Filters](#API_ListCustomLineItemVersions_RequestSyntax) ** A `ListCustomLineItemVersionsFilter` that specifies the billing period range in which the custom line item versions are applied. Type: [ListCustomLineItemVersionsFilter](API_ListCustomLineItemVersionsFilter.md) object Required: No ** [MaxResults](#API_ListCustomLineItemVersions_RequestSyntax) ** The maximum number of custom line item versions to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListCustomLineItemVersions_RequestSyntax) ** The pagination token that's used on subsequent calls to retrieve custom line item versions. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CustomLineItemVersions": [ { "AccountId": "string", "Arn": "string", "AssociationSize": number, "BillingGroupArn": "string", "ChargeDetails": { "Flat": { "ChargeValue": number }, "LineItemFilters": [ { "Attribute": "string", "AttributeValues": [ "string" ], "MatchOption": "string", "Values": [ "string" ] } ], "Percentage": { "PercentageValue": number }, "Type": "string" }, "ComputationRule": "string", "CreationTime": number, "CurrencyCode": "string", "Description": "string", "EndBillingPeriod": "string", "LastModifiedTime": number, "Name": "string", "PresentationDetails": { "Service": "string" }, "ProductCode": "string", "StartBillingPeriod": "string", "StartTime": number } ], "NextToken": "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. ** [CustomLineItemVersions](#API_ListCustomLineItemVersions_ResponseSyntax) ** A list of `CustomLineItemVersionListElements` that are received. Type: Array of [CustomLineItemVersionListElement](API_CustomLineItemVersionListElement.md) objects ** [NextToken](#API_ListCustomLineItemVersions_ResponseSyntax) ** The pagination token that's used on subsequent calls to retrieve custom line item versions. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListCustomLineItemVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListCustomLineItemVersions) # ListPricingPlans A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used. ## Request Syntax ``` POST /list-pricing-plans HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "Arns": [ "string" ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListPricingPlans_RequestSyntax) ** The preferred billing period to get pricing plan. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListPricingPlans_RequestSyntax) ** A `ListPricingPlansFilter` that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information. Type: [ListPricingPlansFilter](API_ListPricingPlansFilter.md) object Required: No ** [MaxResults](#API_ListPricingPlans_RequestSyntax) ** The maximum number of pricing plans to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPricingPlans_RequestSyntax) ** The pagination token that's used on subsequent call to get pricing plans. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingPeriod": "string", "NextToken": "string", "PricingPlans": [ { "Arn": "string", "CreationTime": number, "Description": "string", "LastModifiedTime": number, "Name": "string", "Size": number } ] } ``` ## 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. ** [BillingPeriod](#API_ListPricingPlans_ResponseSyntax) ** The billing period for which the described pricing plans are applicable. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` ** [NextToken](#API_ListPricingPlans_ResponseSyntax) ** The pagination token that's used on subsequent calls to get pricing plans. Type: String ** [PricingPlans](#API_ListPricingPlans_ResponseSyntax) ** A list of `PricingPlanListElement` retrieved. Type: Array of [PricingPlanListElement](API_PricingPlanListElement.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListPricingPlans) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListPricingPlans) # ListPricingPlansAssociatedWithPricingRule A list of the pricing plans that are associated with a pricing rule. ## Request Syntax ``` POST /list-pricing-plans-associated-with-pricing-rule HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "MaxResults": number, "NextToken": "string", "PricingRuleArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListPricingPlansAssociatedWithPricingRule_RequestSyntax) ** The pricing plan billing period for which associations will be listed. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [MaxResults](#API_ListPricingPlansAssociatedWithPricingRule_RequestSyntax) ** The optional maximum number of pricing rule associations to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPricingPlansAssociatedWithPricingRule_RequestSyntax) ** The optional pagination token returned by a previous call. Type: String Required: No ** [PricingRuleArn](#API_ListPricingPlansAssociatedWithPricingRule_RequestSyntax) ** The pricing rule Amazon Resource Name (ARN) for which associations will be listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingPeriod": "string", "NextToken": "string", "PricingPlanArns": [ "string" ], "PricingRuleArn": "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. ** [BillingPeriod](#API_ListPricingPlansAssociatedWithPricingRule_ResponseSyntax) ** The pricing plan billing period for which associations will be listed. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` ** [NextToken](#API_ListPricingPlansAssociatedWithPricingRule_ResponseSyntax) ** The pagination token to be used on subsequent calls. Type: String ** [PricingPlanArns](#API_ListPricingPlansAssociatedWithPricingRule_ResponseSyntax) ** The list containing pricing plans that are associated with the requested pricing rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ** [PricingRuleArn](#API_ListPricingPlansAssociatedWithPricingRule_ResponseSyntax) ** The pricing rule Amazon Resource Name (ARN) for which associations will be listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListPricingPlansAssociatedWithPricingRule) # ListPricingRules Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans. ## Request Syntax ``` POST /list-pricing-rules HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "Filters": { "Arns": [ "string" ] }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListPricingRules_RequestSyntax) ** The preferred billing period to get the pricing plan. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListPricingRules_RequestSyntax) ** A `DescribePricingRuleFilter` that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. Type: [ListPricingRulesFilter](API_ListPricingRulesFilter.md) object Required: No ** [MaxResults](#API_ListPricingRules_RequestSyntax) ** The maximum number of pricing rules to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPricingRules_RequestSyntax) ** The pagination token that's used on subsequent call to get pricing rules. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingPeriod": "string", "NextToken": "string", "PricingRules": [ { "Arn": "string", "AssociatedPricingPlanCount": number, "BillingEntity": "string", "CreationTime": number, "Description": "string", "LastModifiedTime": number, "ModifierPercentage": number, "Name": "string", "Operation": "string", "Scope": "string", "Service": "string", "Tiering": { "FreeTier": { "Activated": boolean } }, "Type": "string", "UsageType": "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. ** [BillingPeriod](#API_ListPricingRules_ResponseSyntax) ** The billing period for which the described pricing rules are applicable. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` ** [NextToken](#API_ListPricingRules_ResponseSyntax) ** The pagination token that's used on subsequent calls to get pricing rules. Type: String ** [PricingRules](#API_ListPricingRules_ResponseSyntax) ** A list containing the described pricing rules. Type: Array of [PricingRuleListElement](API_PricingRuleListElement.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListPricingRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListPricingRules) # ListPricingRulesAssociatedToPricingPlan Lists the pricing rules that are associated with a pricing plan. ## Request Syntax ``` POST /list-pricing-rules-associated-to-pricing-plan HTTP/1.1 Content-type: application/json { "BillingPeriod": "string", "MaxResults": number, "NextToken": "string", "PricingPlanArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [BillingPeriod](#API_ListPricingRulesAssociatedToPricingPlan_RequestSyntax) ** The billing period for which the pricing rule associations are to be listed. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [MaxResults](#API_ListPricingRulesAssociatedToPricingPlan_RequestSyntax) ** The optional maximum number of pricing rule associations to retrieve. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListPricingRulesAssociatedToPricingPlan_RequestSyntax) ** The optional pagination token returned by a previous call. Type: String Required: No ** [PricingPlanArn](#API_ListPricingRulesAssociatedToPricingPlan_RequestSyntax) ** The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "BillingPeriod": "string", "NextToken": "string", "PricingPlanArn": "string", "PricingRuleArns": [ "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. ** [BillingPeriod](#API_ListPricingRulesAssociatedToPricingPlan_ResponseSyntax) ** The billing period for which the pricing rule associations are listed. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` ** [NextToken](#API_ListPricingRulesAssociatedToPricingPlan_ResponseSyntax) ** The pagination token to be used on subsequent calls. Type: String ** [PricingPlanArn](#API_ListPricingRulesAssociatedToPricingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pricing plan for which associations are listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ** [PricingRuleArns](#API_ListPricingRulesAssociatedToPricingPlan_ResponseSyntax) ** A list containing pricing rules that are associated with the requested pricing plan. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListPricingRulesAssociatedToPricingPlan) # ListResourcesAssociatedToCustomLineItem List the resources that are associated to a custom line item. ## Request Syntax ``` POST /list-resources-associated-to-custom-line-item HTTP/1.1 Content-type: application/json { "Arn": "string", "BillingPeriod": "string", "Filters": { "Relationship": "string" }, "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_ListResourcesAssociatedToCustomLineItem_RequestSyntax) ** The ARN of the custom line item for which the resource associations will be listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ** [BillingPeriod](#API_ListResourcesAssociatedToCustomLineItem_RequestSyntax) ** The billing period for which the resource associations will be listed. Type: String Pattern: `\d{4}-(0?[1-9]|1[012])` Required: No ** [Filters](#API_ListResourcesAssociatedToCustomLineItem_RequestSyntax) ** (Optional) A `ListResourcesAssociatedToCustomLineItemFilter` that can specify the types of resources that should be retrieved. Type: [ListResourcesAssociatedToCustomLineItemFilter](API_ListResourcesAssociatedToCustomLineItemFilter.md) object Required: No ** [MaxResults](#API_ListResourcesAssociatedToCustomLineItem_RequestSyntax) ** (Optional) The maximum number of resource associations to be retrieved. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ** [NextToken](#API_ListResourcesAssociatedToCustomLineItem_RequestSyntax) ** (Optional) The pagination token that's returned by a previous request. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "AssociatedResources": [ { "Arn": "string", "EndBillingPeriod": "string", "Relationship": "string" } ], "NextToken": "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. ** [Arn](#API_ListResourcesAssociatedToCustomLineItem_ResponseSyntax) ** The custom line item ARN for which the resource associations are listed. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` ** [AssociatedResources](#API_ListResourcesAssociatedToCustomLineItem_ResponseSyntax) ** A list of `ListResourcesAssociatedToCustomLineItemResponseElement` for each resource association retrieved. Type: Array of [ListResourcesAssociatedToCustomLineItemResponseElement](API_ListResourcesAssociatedToCustomLineItemResponseElement.md) objects ** [NextToken](#API_ListResourcesAssociatedToCustomLineItem_ResponseSyntax) ** The pagination token to be used in subsequent requests to retrieve additional results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListResourcesAssociatedToCustomLineItem) # ListTagsForResource A list the tags for a resource. ## Request Syntax ``` GET /tags/ResourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource to list the tags. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response. The following data is returned in JSON format by the service. ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** The tags for the resource. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/ListTagsForResource) # TagResource Associates the specified tags to a resource with the specified `resourceArn`. If existing tags on a resource are not specified in the request parameters, they are not changed. ## Request Syntax ``` POST /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to which to add tags. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Tags](#API_TagResource_RequestSyntax) ** The tags to add to the resource as a list of key-value pairs. Type: String to string map Map Entries: Maximum number of 200 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/TagResource) # UntagResource Deletes specified tags from a resource. ## Request Syntax ``` DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ResourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to which to delete tags. Length Constraints: Minimum length of 0. Maximum length of 100. Pattern: `arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/?[0-9]{12}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingplan/[a-zA-Z0-9]{10}$|^arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/[a-zA-Z0-9]{10}$|^(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The tags to delete from the resource as a list of key-value pairs. Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/UntagResource) # UpdateBillingGroup This updates an existing billing group. ## Request Syntax ``` POST /update-billing-group HTTP/1.1 Content-type: application/json { "AccountGrouping": { "AutoAssociate": boolean, "ResponsibilityTransferArn": "string" }, "Arn": "string", "ComputationPreference": { "PricingPlanArn": "string" }, "Description": "string", "Name": "string", "Status": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AccountGrouping](#API_UpdateBillingGroup_RequestSyntax) ** Specifies if the billing group has automatic account association (`AutoAssociate`) enabled. Type: [UpdateBillingGroupAccountGrouping](API_UpdateBillingGroupAccountGrouping.md) object Required: No ** [Arn](#API_UpdateBillingGroup_RequestSyntax) ** The Amazon Resource Name (ARN) of the billing group being updated. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` Required: Yes ** [ComputationPreference](#API_UpdateBillingGroup_RequestSyntax) ** The preferences and settings that will be used to compute the AWS charges for a billing group. Type: [ComputationPreference](API_ComputationPreference.md) object Required: No ** [Description](#API_UpdateBillingGroup_RequestSyntax) ** A description of the billing group. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [Name](#API_UpdateBillingGroup_RequestSyntax) ** The name of the billing group. The names must be unique to each billing group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: No ** [Status](#API_UpdateBillingGroup_RequestSyntax) ** The status of the billing group. Only one of the valid values can be used. Type: String Valid Values: `ACTIVE | PRIMARY_ACCOUNT_MISSING | PENDING` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AccountGrouping": { "AutoAssociate": boolean, "ResponsibilityTransferArn": "string" }, "Arn": "string", "Description": "string", "LastModifiedTime": number, "Name": "string", "PricingPlanArn": "string", "PrimaryAccountId": "string", "Size": number, "Status": "string", "StatusReason": "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. ** [AccountGrouping](#API_UpdateBillingGroup_ResponseSyntax) ** Specifies if the billing group has automatic account association (`AutoAssociate`) enabled. Type: [UpdateBillingGroupAccountGrouping](API_UpdateBillingGroupAccountGrouping.md) object ** [Arn](#API_UpdateBillingGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the billing group that was updated. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/)?[a-zA-Z0-9]{10,12}` ** [Description](#API_UpdateBillingGroup_ResponseSyntax) ** A description of the billing group. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_UpdateBillingGroup_ResponseSyntax) ** The most recent time when the billing group was modified. Type: Long ** [Name](#API_UpdateBillingGroup_ResponseSyntax) ** The name of the billing group. The names must be unique to each billing group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` ** [PricingPlanArn](#API_UpdateBillingGroup_ResponseSyntax) ** The Amazon Resource Name (ARN) of the pricing plan to compute AWS charges for the billing group. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ** [PrimaryAccountId](#API_UpdateBillingGroup_ResponseSyntax) ** The account ID that serves as the main account in a billing group. Type: String Pattern: `[0-9]{12}` ** [Size](#API_UpdateBillingGroup_ResponseSyntax) ** The number of accounts in the particular billing group. Type: Long Valid Range: Minimum value of 0. ** [Status](#API_UpdateBillingGroup_ResponseSyntax) ** The status of the billing group. Only one of the valid values can be used. Type: String Valid Values: `ACTIVE | PRIMARY_ACCOUNT_MISSING | PENDING` ** [StatusReason](#API_UpdateBillingGroup_ResponseSyntax) ** The reason why the billing group is in its current status. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/UpdateBillingGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/UpdateBillingGroup) # UpdateCustomLineItem Update an existing custom line item in the current or previous billing period. ## Request Syntax ``` POST /update-custom-line-item HTTP/1.1 Content-type: application/json { "Arn": "string", "BillingPeriodRange": { "ExclusiveEndBillingPeriod": "string", "InclusiveStartBillingPeriod": "string" }, "ChargeDetails": { "Flat": { "ChargeValue": number }, "LineItemFilters": [ { "Attribute": "string", "AttributeValues": [ "string" ], "MatchOption": "string", "Values": [ "string" ] } ], "Percentage": { "PercentageValue": number } }, "Description": "string", "Name": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_UpdateCustomLineItem_RequestSyntax) ** The ARN of the custom line item to be updated. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` Required: Yes ** [BillingPeriodRange](#API_UpdateCustomLineItem_RequestSyntax) ** The billing period range in which the custom line item request will be applied. Type: [CustomLineItemBillingPeriodRange](API_CustomLineItemBillingPeriodRange.md) object Required: No ** [ChargeDetails](#API_UpdateCustomLineItem_RequestSyntax) ** A `ListCustomLineItemChargeDetails` containing the new charge details for the custom line item. Type: [UpdateCustomLineItemChargeDetails](API_UpdateCustomLineItemChargeDetails.md) object Required: No ** [Description](#API_UpdateCustomLineItem_RequestSyntax) ** The new line item description of the custom line item. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No ** [Name](#API_UpdateCustomLineItem_RequestSyntax) ** The new name for the custom line item. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "AssociationSize": number, "BillingGroupArn": "string", "ChargeDetails": { "Flat": { "ChargeValue": number }, "LineItemFilters": [ { "Attribute": "string", "AttributeValues": [ "string" ], "MatchOption": "string", "Values": [ "string" ] } ], "Percentage": { "PercentageValue": number }, "Type": "string" }, "Description": "string", "LastModifiedTime": number, "Name": "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. ** [Arn](#API_UpdateCustomLineItem_ResponseSyntax) ** The ARN of the successfully updated custom line item. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}` ** [AssociationSize](#API_UpdateCustomLineItem_ResponseSyntax) ** The number of resources that are associated to the custom line item. Type: Long Valid Range: Minimum value of 0. ** [BillingGroupArn](#API_UpdateCustomLineItem_ResponseSyntax) ** The ARN of the billing group that the custom line item is applied to. Type: String Pattern: `arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/[a-zA-Z0-9]{10,12}` ** [ChargeDetails](#API_UpdateCustomLineItem_ResponseSyntax) ** A `ListCustomLineItemChargeDetails` containing the charge details of the successfully updated custom line item. Type: [ListCustomLineItemChargeDetails](API_ListCustomLineItemChargeDetails.md) object ** [Description](#API_UpdateCustomLineItem_ResponseSyntax) ** The description of the successfully updated custom line item. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ** [LastModifiedTime](#API_UpdateCustomLineItem_ResponseSyntax) ** The most recent time when the custom line item was modified. Type: Long ** [Name](#API_UpdateCustomLineItem_ResponseSyntax) ** The name of the successfully updated custom line item. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/UpdateCustomLineItem) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/UpdateCustomLineItem) # UpdatePricingPlan This updates an existing pricing plan. ## Request Syntax ``` PUT /update-pricing-plan HTTP/1.1 Content-type: application/json { "Arn": "string", "Description": "string", "Name": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_UpdatePricingPlan_RequestSyntax) ** The Amazon Resource Name (ARN) of the pricing plan that you're updating. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` Required: Yes ** [Description](#API_UpdatePricingPlan_RequestSyntax) ** The description of the pricing plan. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [Name](#API_UpdatePricingPlan_RequestSyntax) ** The name of the pricing plan. The name must be unique to each pricing plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Description": "string", "LastModifiedTime": number, "Name": "string", "Size": number } ``` ## 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. ** [Arn](#API_UpdatePricingPlan_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated pricing plan. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::(aws|[0-9]{12}):pricingplan/)?(BasicPricingPlan|[a-zA-Z0-9]{10})` ** [Description](#API_UpdatePricingPlan_ResponseSyntax) ** The new description for the pricing rule. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_UpdatePricingPlan_ResponseSyntax) ** The most recent time when the pricing plan was modified. Type: Long ** [Name](#API_UpdatePricingPlan_ResponseSyntax) ** The name of the pricing plan. The name must be unique to each pricing plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` ** [Size](#API_UpdatePricingPlan_ResponseSyntax) ** The pricing rules count that's currently associated with this pricing plan list. Type: Long Valid Range: Minimum value of 1. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/UpdatePricingPlan) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/UpdatePricingPlan) # UpdatePricingRule Updates an existing pricing rule. ## Request Syntax ``` PUT /update-pricing-rule HTTP/1.1 Content-type: application/json { "Arn": "string", "Description": "string", "ModifierPercentage": number, "Name": "string", "Tiering": { "FreeTier": { "Activated": boolean } }, "Type": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Arn](#API_UpdatePricingRule_RequestSyntax) ** The Amazon Resource Name (ARN) of the pricing rule to update. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` Required: Yes ** [Description](#API_UpdatePricingRule_RequestSyntax) ** The new description for the pricing rule. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ** [ModifierPercentage](#API_UpdatePricingRule_RequestSyntax) ** The new modifier to show pricing plan rates as a percentage. Your entry will be rounded to the nearest 2 decimal places. Type: Double Valid Range: Minimum value of 0. Required: No ** [Name](#API_UpdatePricingRule_RequestSyntax) ** The new name of the pricing rule. The name must be unique to each pricing rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` Required: No ** [Tiering](#API_UpdatePricingRule_RequestSyntax) ** The set of tiering configurations for the pricing rule. Type: [UpdateTieringInput](API_UpdateTieringInput.md) object Required: No ** [Type](#API_UpdatePricingRule_RequestSyntax) ** The new pricing rule type. Type: String Valid Values: `MARKUP | DISCOUNT | TIERING` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "AssociatedPricingPlanCount": number, "BillingEntity": "string", "Description": "string", "LastModifiedTime": number, "ModifierPercentage": number, "Name": "string", "Operation": "string", "Scope": "string", "Service": "string", "Tiering": { "FreeTier": { "Activated": boolean } }, "Type": "string", "UsageType": "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. ** [Arn](#API_UpdatePricingRule_ResponseSyntax) ** The Amazon Resource Name (ARN) of the successfully updated pricing rule. Type: String Pattern: `(arn:aws(-cn)?:billingconductor::[0-9]{12}:pricingrule/)?[a-zA-Z0-9]{10}` ** [AssociatedPricingPlanCount](#API_UpdatePricingRule_ResponseSyntax) ** The pricing plans count that this pricing rule is associated with. Type: Long Valid Range: Minimum value of 0. ** [BillingEntity](#API_UpdatePricingRule_ResponseSyntax) ** The seller of services provided by AWS, their affiliates, or third-party providers selling services via AWS Marketplace. Type: String Pattern: `[a-zA-Z0-9() ]+` ** [Description](#API_UpdatePricingRule_ResponseSyntax) ** The new description for the pricing rule. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. ** [LastModifiedTime](#API_UpdatePricingRule_ResponseSyntax) ** The most recent time the pricing rule was modified. Type: Long ** [ModifierPercentage](#API_UpdatePricingRule_ResponseSyntax) ** The new modifier to show pricing plan rates as a percentage. Type: Double Valid Range: Minimum value of 0. ** [Name](#API_UpdatePricingRule_ResponseSyntax) ** The new name of the pricing rule. The name must be unique to each pricing rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_\+=\.\-@]+` ** [Operation](#API_UpdatePricingRule_ResponseSyntax) ** Operation refers to the specific AWS covered by this line item. This describes the specific usage of the line item. If the `Scope` attribute is set to `SKU`, this attribute indicates which operation the `PricingRule` is modifying. For example, a value of `RunInstances:0202` indicates the operation of running an Amazon EC2 instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` ** [Scope](#API_UpdatePricingRule_ResponseSyntax) ** The scope of pricing rule that indicates if it's globally applicable, or it's service-specific. Type: String Valid Values: `GLOBAL | SERVICE | BILLING_ENTITY | SKU` ** [Service](#API_UpdatePricingRule_ResponseSyntax) ** If the `Scope` attribute is set to `SERVICE`, the attribute indicates which service the `PricingRule` is applicable for. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9]+` ** [Tiering](#API_UpdatePricingRule_ResponseSyntax) ** The set of tiering configurations for the pricing rule. Type: [UpdateTieringInput](API_UpdateTieringInput.md) object ** [Type](#API_UpdatePricingRule_ResponseSyntax) ** The new pricing rule type. Type: String Valid Values: `MARKUP | DISCOUNT | TIERING` ** [UsageType](#API_UpdatePricingRule_ResponseSyntax) ** Usage type is the unit that each service uses to measure the usage of a specific type of resource. If the `Scope` attribute is set to `SKU`, this attribute indicates which usage type the `PricingRule` is modifying. For example, `USW2-BoxUsage:m2.2xlarge` describes an `M2 High Memory Double Extra Large` instance in the US West (Oregon) Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `\S+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/billingconductor-2021-07-30/UpdatePricingRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/billingconductor-2021-07-30/UpdatePricingRule)