AcknowledgeOrderReceipt - AWS Private 5G

AcknowledgeOrderReceipt

Acknowledges that the specified network order was received.

Request Syntax

POST /v1/orders/acknowledge HTTP/1.1 Content-type: application/json { "orderArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

orderArn

The Amazon Resource Name (ARN) of the order.

Type: String

Pattern: ^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "order": { "acknowledgmentStatus": "string", "createdAt": "string", "networkArn": "string", "networkSiteArn": "string", "orderArn": "string", "orderedResources": [ { "commitmentConfiguration": { "automaticRenewal": boolean, "commitmentLength": "string" }, "count": number, "type": "string" } ], "shippingAddress": { "city": "string", "company": "string", "country": "string", "emailAddress": "string", "name": "string", "phoneNumber": "string", "postalCode": "string", "stateOrProvince": "string", "street1": "string", "street2": "string", "street3": "string" }, "trackingInformation": [ { "trackingNumber": "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.

order

Information about the order.

Type: Order object

Errors

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

InternalServerException

Information about an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ValidationException

The request failed validation.

HTTP Status Code: 400

See Also

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