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

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

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

The billing period for which the resource associations will be listed.

Type: String

Pattern: \d{4}-(0?[1-9]|1[012])

Required: No

Filters

(Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved.

Type: ListResourcesAssociatedToCustomLineItemFilter object

Required: No

MaxResults

(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

(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

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

A list of ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.

Type: Array of ListResourcesAssociatedToCustomLineItemResponseElement objects

NextToken

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 Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400