ListRegistrationAssociations
Retrieve all of the origination identities that are associated with a registration.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "string",
"RegistrationId": "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.
- Filters
-
An array of RegistrationAssociationFilter to apply to the results that are returned.
Type: Array of RegistrationAssociationFilter objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
- MaxResults
-
The maximum number of results to return per each request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+Required: No
- RegistrationId
-
The unique identifier for the registration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
Response Syntax
{
"NextToken": "string",
"RegistrationArn": "string",
"RegistrationAssociations": [
{
"IsoCountryCode": "string",
"PhoneNumber": "string",
"ResourceArn": "string",
"ResourceId": "string",
"ResourceType": "string"
}
],
"RegistrationId": "string",
"RegistrationType": "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 be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+ - RegistrationArn
-
The Amazon Resource Name (ARN) for the registration.
Type: String
- RegistrationAssociations
-
An array of RegistrationAssociationMetadata objects.
Type: Array of RegistrationAssociationMetadata objects
- RegistrationId
-
The unique identifier for the registration.
Type: String
- RegistrationType
-
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
