GetPhoneNumberOrder
Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
Request Syntax
GET /phone-number-orders/phoneNumberOrderId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- phoneNumberOrderId
-
The ID of the phone number order .
Pattern:
[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"PhoneNumberOrder": {
"CreatedTimestamp": "string",
"OrderedPhoneNumbers": [
{
"E164PhoneNumber": "string",
"Status": "string"
}
],
"OrderType": "string",
"PhoneNumberOrderId": "string",
"ProductType": "string",
"Status": "string",
"UpdatedTimestamp": "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.
- PhoneNumberOrder
-
The phone number order details.
Type: PhoneNumberOrder object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
The requested resource couldn't be found.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The number of customer requests exceeds the request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client isn't authorized to request a resource.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
