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

GetFlowMetadata

Retrieves the metadata of a flow, not including its definition specifying the steps.

Request Syntax


GET /accounts/AwsAccountId/flows/FlowId/metadata HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the flow that you are getting metadata for.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: Yes

FlowId

The unique identifier of the flow.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreatedTime": number,
   "Description": "string",
   "FlowId": "string",
   "LastUpdatedTime": number,
   "Name": "string",
   "PublishState": "string",
   "RequestId": "string",
   "RunCount": number,
   "UserCount": number
}

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.

Arn

The Amazon Resource Name (ARN) of the flow.

Type: String

CreatedTime

The time this flow was created.

Type: Timestamp

FlowId

The unique identifier of the flow.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Name

A display name for the flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Description

The description for the flow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

LastUpdatedTime

The last time this flow was modified.

Type: Timestamp

PublishState

The publish state for the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

Type: String

Valid Values: PUBLISHED | DRAFT | PENDING_APPROVAL

RequestId

The AWS request ID for this operation.

Type: String

RunCount

The number of runs done for the flow.

Type: Integer

UserCount

The number of users who have used the flow.

Type: Integer

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