ProtectedQuery - AWS Clean Rooms

ProtectedQuery

The parameters for an AWS Clean Rooms protected query.

Contents

createTime

The time at which the protected query was created.

Type: Timestamp

Required: Yes

id

The identifier for a protected query instance.

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

membershipArn

The ARN of the membership.

Type: String

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

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+

Required: Yes

membershipId

The identifier for the membership.

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

status

The status of the query.

Type: String

Valid Values: SUBMITTED | STARTED | CANCELLED | CANCELLING | FAILED | SUCCESS | TIMED_OUT

Required: Yes

computeConfiguration

The compute configuration for the protected query.

Type: ComputeConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

differentialPrivacy

The sensitivity parameters of the differential privacy results of the protected query.

Type: DifferentialPrivacyParameters object

Required: No

error

An error thrown by the protected query.

Type: ProtectedQueryError object

Required: No

result

The result of the protected query.

Type: ProtectedQueryResult object

Required: No

resultConfiguration

Contains any details needed to write the query results.

Type: ProtectedQueryResultConfiguration object

Required: No

sqlParameters

The protected query SQL parameters.

Type: ProtectedQuerySQLParameters object

Required: No

statistics

Statistics about protected query execution.

Type: ProtectedQueryStatistics object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: