Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchActionConnectors

Searches for action connectors in the specified AWS account using filters. You can search by connector name, type, or user permissions.

Request Syntax


POST /accounts/AwsAccountId/search/action-connectors?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID in which to search for 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 0. 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 searching.

Request Body

The request accepts the following data in JSON format.

Filters

The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.

Type: Array of ActionConnectorSearchFilter objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: Yes

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 that match the search criteria.

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 AWS 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 AWS request ID for this request.

HTTP Status Code: 401

InvalidNextTokenException

The NextToken value isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429