BatchGetFlowAssociation
Retrieve the flow associations for the given resources.
Request Syntax
POST /flow-associations-batch/InstanceId
HTTP/1.1
Content-type: application/json
{
"ResourceIds": [ "string
" ],
"ResourceType": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ResourceIds
-
A list of resource identifiers to retrieve flow associations.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
- ResourceType
-
The type of resource association.
Type: String
Valid Values:
VOICE_PHONE_NUMBER
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"FlowAssociationSummaryList": [
{
"FlowId": "string",
"ResourceId": "string",
"ResourceType": "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.
- FlowAssociationSummaryList
-
Information about flow associations.
Type: Array of FlowAssociationSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: