ListActionConnectors
Lists all action connectors in the specified Amazon account. Returns summary information for each connector including its name, type, creation time, and status.
Request Syntax
GET /accounts/AwsAccountId/action-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The Amazon account ID for which to list action connectors.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- MaxResults
-
The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"ActionConnectorSummaries": [
{
"ActionConnectorId": "string",
"Arn": "string",
"CreatedTime": number,
"Error": {
"Message": "string",
"Type": "string"
},
"LastUpdatedTime": number,
"Name": "string",
"Status": "string",
"Type": "string"
}
],
"NextToken": "string",
"RequestId": "string"
}
Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status code of the request.
The following data is returned in JSON format by the service.
- ActionConnectorSummaries
-
A list of action connector summaries containing basic information about each connector.
Type: Array of ActionConnectorSummary objects
- NextToken
-
A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.
Type: String
- RequestId
-
The Amazon request ID for this operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 401
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextTokenvalue isn't valid.- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 400
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 400
- ThrottlingException
-
Access is throttled.
- RequestId
-
The Amazon request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: