Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListProcurementPortalSuppliers

Returns the suppliers configured for a specified procurement portal, including supplier identifiers and associated metadata. For faster, more reliable responses, use pagination.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "PortalIdentifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next set of results. You received this token from a previous call.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

Required: No

PortalIdentifier

The unique identifier of the procurement portal for which to list suppliers. Use the PortalIdentifier value returned by ListProcurementPortals.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "ProcurementPortalSuppliers": [ 
      { 
         "CountryCode": "string",
         "Environment": "string",
         "SellerOfRecord": "string",
         "SupplierIdentifier": "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.

NextToken

The token to use to retrieve the next set of results, or null if there are no more results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

ProcurementPortalSuppliers

The list of suppliers configured for the specified procurement portal.

Type: Array of ProcurementPortalSupplier objects

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The processing request failed because of an unknown error, exception, or failure.

retryAfterSeconds: The processing request failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

resourceName: The resource could not be found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The input fails to satisfy the constraints specified by an AWS service.
reason: You don't have sufficient access to perform this action.
resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400