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

SearchFlows

Search for the flows in an AWS account.

Request Syntax


POST /accounts/AwsAccountId/flows/searchFlows HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account where you are searching for flows from.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Filters

The filters applied to the search when searching for flows in the AWS account.

Type: Array of SearchFlowsFilter objects

Required: Yes

MaxResults

The maximum number of results to be returned per request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to request the next set of results, or null if you want to retrieve the first set.

Type: String

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "FlowSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedBy": "string",
         "CreatedTime": number,
         "Description": "string",
         "FlowId": "string",
         "LastPublishedAt": number,
         "LastPublishedBy": "string",
         "LastUpdatedBy": "string",
         "LastUpdatedTime": number,
         "Name": "string",
         "PublishState": "string",
         "RunCount": number,
         "UserCount": number
      }
   ],
   "NextToken": "string",
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

FlowSummaryList

The list of flows found against the search.

Type: Array of FlowSummary objects

NextToken

The token for the next set of results, or null if there are no more results.

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

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

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