GetAgreementContacts
Obtains details about the acceptor's contact information for an active agreement that you participate in as the proposer, acceptor, or manufacturer.
If the acceptor's contact information isn't available, the operation succeeds but
doesn't return acceptorContact. This happens when the acceptor didn't
provide it, the information was removed, or the agreement isn't active.
Request Syntax
{
"agreementId": "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.
In the following list, the required parameters are described first.
- agreementId
-
The unique identifier of the agreement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_/-]+Required: Yes
Response Syntax
{
"acceptorContact": {
"companyName": "string",
"countryCode": "string",
"emailAddress": "string",
"firstName": "string",
"lastName": "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.
- acceptorContact
-
The contact information that the acceptor provided when creating the agreement.
Type: AcceptorContact object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
- message
-
Description of the error.
- reason
-
The reason for the access denied exception.
- requestId
-
The unique identifier for the error.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of request.
- message
-
Description of the error.
- requestId
-
The unique identifier for the error.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
- message
-
Description of the error.
- requestId
-
The unique identifier for the error.
- resourceId
-
The unique identifier for the resource.
- resourceType
-
The type of resource.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
- message
-
Description of the error.
- requestId
-
The unique identifier for the error.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
- fields
-
The fields associated with the error.
- message
-
Description of the error.
- reason
-
The reason associated with the error.
- requestId
-
The unique identifier associated with the error.
HTTP Status Code: 400
Examples
Sample request
This example illustrates one usage of GetAgreementContacts.
{ "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95" }
Sample response
This example illustrates one usage of GetAgreementContacts.
{ "acceptorContact": { "firstName": "FirstName", "lastName": "LastName", "emailAddress": "user@example.com", "companyName": "AnyCompany", "countryCode": "US" } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: