AWS Clean Rooms Service 2022-02-17
- Client: Aws\CleanRooms\CleanRoomsClient
- Service ID: cleanrooms
- Version: 2022-02-17
This page describes the parameters and results for the operations of the AWS Clean Rooms Service (2022-02-17), and shows how to use the Aws\CleanRooms\CleanRoomsClient object to call the described operations. This documentation is specific to the 2022-02-17 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchGetSchema ( array $params = [] )
Retrieves multiple schemas by their identifiers.
- CreateCollaboration ( array $params = [] )
Creates a new collaboration.
- CreateConfiguredTable ( array $params = [] )
Creates a new configured table resource.
- CreateConfiguredTableAnalysisRule ( array $params = [] )
Creates a new analysis rule for a configured table.
- CreateConfiguredTableAssociation ( array $params = [] )
Creates a configured table association.
- CreateMembership ( array $params = [] )
Creates a membership for a specific collaboration identifier and joins the collaboration.
- DeleteCollaboration ( array $params = [] )
Deletes a collaboration.
- DeleteConfiguredTable ( array $params = [] )
Deletes a configured table.
- DeleteConfiguredTableAnalysisRule ( array $params = [] )
Deletes a configured table analysis rule.
- DeleteConfiguredTableAssociation ( array $params = [] )
Deletes a configured table association.
- DeleteMember ( array $params = [] )
Removes the specified member from a collaboration.
- DeleteMembership ( array $params = [] )
Deletes a specified membership.
- GetCollaboration ( array $params = [] )
Returns metadata about a collaboration.
- GetConfiguredTable ( array $params = [] )
Retrieves a configured table.
- GetConfiguredTableAnalysisRule ( array $params = [] )
Retrieves a configured table analysis rule.
- GetConfiguredTableAssociation ( array $params = [] )
Retrieves a configured table association.
- GetMembership ( array $params = [] )
Retrieves a specified membership for an identifier.
- GetProtectedQuery ( array $params = [] )
Returns query processing metadata.
- GetSchema ( array $params = [] )
Retrieves the schema for a relation within a collaboration.
- GetSchemaAnalysisRule ( array $params = [] )
Retrieves a schema analysis rule.
- ListCollaborations ( array $params = [] )
Lists collaborations the caller owns, is active in, or has been invited to.
- ListConfiguredTableAssociations ( array $params = [] )
Lists configured table associations for a membership.
- ListConfiguredTables ( array $params = [] )
Lists configured tables.
- ListMembers ( array $params = [] )
Lists all members within a collaboration.
- ListMemberships ( array $params = [] )
Lists all memberships resources within the caller's account.
- ListProtectedQueries ( array $params = [] )
Lists protected queries, sorted by the most recent query.
- ListSchemas ( array $params = [] )
Lists the schemas for relations within a collaboration.
- ListTagsForResource ( array $params = [] )
Lists all of the tags that have been added to a resource.
- StartProtectedQuery ( array $params = [] )
Creates a protected query that is started by AWS Clean Rooms.
- TagResource ( array $params = [] )
Tags a resource.
- UntagResource ( array $params = [] )
Removes a tag or list of tags from a resource.
- UpdateCollaboration ( array $params = [] )
Updates collaboration metadata and can only be called by the collaboration owner.
- UpdateConfiguredTable ( array $params = [] )
Updates a configured table.
- UpdateConfiguredTableAnalysisRule ( array $params = [] )
Updates a configured table analysis rule.
- UpdateConfiguredTableAssociation ( array $params = [] )
Updates a configured table association.
- UpdateMembership ( array $params = [] )
Updates a membership.
- UpdateProtectedQuery ( array $params = [] )
Updates the processing of a currently running query.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchGetSchema
$result = $client->batchGetSchema([/* ... */]); $promise = $client->batchGetSchemaAsync([/* ... */]);
Retrieves multiple schemas by their identifiers.
Parameter Syntax
$result = $client->batchGetSchema([
'collaborationIdentifier' => '<string>', // REQUIRED
'names' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
- names
-
- Required: Yes
- Type: Array of strings
The names for the schema objects to retrieve.>
Result Syntax
[
'errors' => [
[
'code' => '<string>',
'message' => '<string>',
'name' => '<string>',
],
// ...
],
'schemas' => [
[
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'collaborationArn' => '<string>',
'collaborationId' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
],
// ...
],
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'description' => '<string>',
'name' => '<string>',
'partitionKeys' => [
[
'name' => '<string>',
'type' => '<string>',
],
// ...
],
'type' => 'TABLE',
'updateTime' => <DateTime>,
],
// ...
],
]
Result Details
Members
- errors
-
- Required: Yes
- Type: Array of BatchGetSchemaError structures
Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
- schemas
-
- Required: Yes
- Type: Array of Schema structures
The retrieved list of schemas.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
CreateCollaboration
$result = $client->createCollaboration([/* ... */]); $promise = $client->createCollaborationAsync([/* ... */]);
Creates a new collaboration.
Parameter Syntax
$result = $client->createCollaboration([
'creatorDisplayName' => '<string>', // REQUIRED
'creatorMemberAbilities' => ['<string>', ...], // REQUIRED
'dataEncryptionMetadata' => [
'allowCleartext' => true || false, // REQUIRED
'allowDuplicates' => true || false, // REQUIRED
'allowJoinsOnColumnsWithDifferentNames' => true || false, // REQUIRED
'preserveNulls' => true || false, // REQUIRED
],
'description' => '<string>', // REQUIRED
'members' => [ // REQUIRED
[
'accountId' => '<string>', // REQUIRED
'displayName' => '<string>', // REQUIRED
'memberAbilities' => ['<string>', ...], // REQUIRED
],
// ...
],
'name' => '<string>', // REQUIRED
'queryLogStatus' => 'ENABLED|DISABLED', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- creatorDisplayName
-
- Required: Yes
- Type: string
The display name of the collaboration creator.
- creatorMemberAbilities
-
- Required: Yes
- Type: Array of strings
The abilities granted to the collaboration creator.
- dataEncryptionMetadata
-
- Type: DataEncryptionMetadata structure
The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
- description
-
- Required: Yes
- Type: string
A description of the collaboration provided by the collaboration owner.
- members
-
- Required: Yes
- Type: Array of MemberSpecification structures
A list of initial members, not including the creator. This list is immutable.
- name
-
- Required: Yes
- Type: string
The display name for a collaboration.
- queryLogStatus
-
- Required: Yes
- Type: string
An indicator as to whether query logging has been enabled or disabled for the collaboration.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Result Syntax
[
'collaboration' => [
'arn' => '<string>',
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'creatorDisplayName' => '<string>',
'dataEncryptionMetadata' => [
'allowCleartext' => true || false,
'allowDuplicates' => true || false,
'allowJoinsOnColumnsWithDifferentNames' => true || false,
'preserveNulls' => true || false,
],
'description' => '<string>',
'id' => '<string>',
'memberStatus' => 'INVITED|ACTIVE|LEFT|REMOVED',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'queryLogStatus' => 'ENABLED|DISABLED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- collaboration
-
- Required: Yes
- Type: Collaboration structure
The entire created collaboration object.
Errors
-
ServiceQuotaExceededException:
Request denied because service quota has been exceeded.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
CreateConfiguredTable
$result = $client->createConfiguredTable([/* ... */]); $promise = $client->createConfiguredTableAsync([/* ... */]);
Creates a new configured table resource.
Parameter Syntax
$result = $client->createConfiguredTable([
'allowedColumns' => ['<string>', ...], // REQUIRED
'analysisMethod' => 'DIRECT_QUERY', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tableReference' => [ // REQUIRED
'glue' => [
'databaseName' => '<string>', // REQUIRED
'tableName' => '<string>', // REQUIRED
],
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- allowedColumns
-
- Required: Yes
- Type: Array of strings
The columns of the underlying table that can be used by collaborations or analysis rules.
- analysisMethod
-
- Required: Yes
- Type: string
The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
- description
-
- Type: string
A description for the configured table.
- name
-
- Required: Yes
- Type: string
The name of the configured table.
- tableReference
-
- Required: Yes
- Type: TableReference structure
A reference to the AWS Glue table being configured.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Result Syntax
[
'configuredTable' => [
'allowedColumns' => ['<string>', ...],
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'arn' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'tableReference' => [
'glue' => [
'databaseName' => '<string>',
'tableName' => '<string>',
],
],
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTable
-
- Required: Yes
- Type: ConfiguredTable structure
The created configured table.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
ServiceQuotaExceededException:
Request denied because service quota has been exceeded.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
CreateConfiguredTableAnalysisRule
$result = $client->createConfiguredTableAnalysisRule([/* ... */]); $promise = $client->createConfiguredTableAnalysisRuleAsync([/* ... */]);
Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
Parameter Syntax
$result = $client->createConfiguredTableAnalysisRule([
'analysisRulePolicy' => [ // REQUIRED
'v1' => [
'aggregation' => [
'aggregateColumns' => [ // REQUIRED
[
'columnNames' => ['<string>', ...], // REQUIRED
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG', // REQUIRED
],
// ...
],
'dimensionColumns' => ['<string>', ...], // REQUIRED
'joinColumns' => ['<string>', ...], // REQUIRED
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [ // REQUIRED
[
'columnName' => '<string>', // REQUIRED
'minimum' => <integer>, // REQUIRED
'type' => 'COUNT_DISTINCT', // REQUIRED
],
// ...
],
'scalarFunctions' => ['<string>', ...], // REQUIRED
],
'list' => [
'joinColumns' => ['<string>', ...], // REQUIRED
'listColumns' => ['<string>', ...], // REQUIRED
],
],
],
'analysisRuleType' => 'AGGREGATION|LIST', // REQUIRED
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- analysisRulePolicy
-
- Required: Yes
- Type: ConfiguredTableAnalysisRulePolicy structure
The entire created configured table analysis rule object.
- analysisRuleType
-
- Required: Yes
- Type: string
The type of analysis rule. Valid values are AGGREGATION and LIST.
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
Result Syntax
[
'analysisRule' => [
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'policy' => [
'v1' => [
'aggregation' => [
'aggregateColumns' => [
[
'columnNames' => ['<string>', ...],
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
],
// ...
],
'dimensionColumns' => ['<string>', ...],
'joinColumns' => ['<string>', ...],
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [
[
'columnName' => '<string>',
'minimum' => <integer>,
'type' => 'COUNT_DISTINCT',
],
// ...
],
'scalarFunctions' => ['<string>', ...],
],
'list' => [
'joinColumns' => ['<string>', ...],
'listColumns' => ['<string>', ...],
],
],
],
'type' => 'AGGREGATION|LIST',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- analysisRule
-
- Required: Yes
- Type: ConfiguredTableAnalysisRule structure
The entire created analysis rule.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
CreateConfiguredTableAssociation
$result = $client->createConfiguredTableAssociation([/* ... */]); $promise = $client->createConfiguredTableAssociationAsync([/* ... */]);
Creates a configured table association. A configured table association links a configured table with a collaboration.
Parameter Syntax
$result = $client->createConfiguredTableAssociation([
'configuredTableIdentifier' => '<string>', // REQUIRED
'description' => '<string>',
'membershipIdentifier' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'roleArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- configuredTableIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
- description
-
- Type: string
A description for the configured table association.
- membershipIdentifier
-
- Required: Yes
- Type: string
A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
- name
-
- Required: Yes
- Type: string
The name of the configured table association. This name is used to query the underlying configured table.
- roleArn
-
- Required: Yes
- Type: string
The service will assume this role to access catalog metadata and query the table.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Result Syntax
[
'configuredTableAssociation' => [
'arn' => '<string>',
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'roleArn' => '<string>',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTableAssociation
-
- Required: Yes
- Type: ConfiguredTableAssociation structure
The entire configured table association object.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
ServiceQuotaExceededException:
Request denied because service quota has been exceeded.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
CreateMembership
$result = $client->createMembership([/* ... */]); $promise = $client->createMembershipAsync([/* ... */]);
Creates a membership for a specific collaboration identifier and joins the collaboration.
Parameter Syntax
$result = $client->createMembership([
'collaborationIdentifier' => '<string>', // REQUIRED
'queryLogStatus' => 'ENABLED|DISABLED', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
The unique ID for the associated collaboration.
- queryLogStatus
-
- Required: Yes
- Type: string
An indicator as to whether query logging has been enabled or disabled for the collaboration.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Result Syntax
[
'membership' => [
'arn' => '<string>',
'collaborationArn' => '<string>',
'collaborationCreatorAccountId' => '<string>',
'collaborationCreatorDisplayName' => '<string>',
'collaborationId' => '<string>',
'collaborationName' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'memberAbilities' => ['<string>', ...],
'queryLogStatus' => 'ENABLED|DISABLED',
'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- membership
-
- Required: Yes
- Type: Membership structure
The membership that was created.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
ServiceQuotaExceededException:
Request denied because service quota has been exceeded.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteCollaboration
$result = $client->deleteCollaboration([/* ... */]); $promise = $client->deleteCollaborationAsync([/* ... */]);
Deletes a collaboration. It can only be called by the collaboration owner.
Parameter Syntax
$result = $client->deleteCollaboration([
'collaborationIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
The identifier for the collaboration.
Result Syntax
[]
Result Details
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteConfiguredTable
$result = $client->deleteConfiguredTable([/* ... */]); $promise = $client->deleteConfiguredTableAsync([/* ... */]);
Deletes a configured table.
Parameter Syntax
$result = $client->deleteConfiguredTable([
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The unique ID for the configured table to delete.
Result Syntax
[]
Result Details
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteConfiguredTableAnalysisRule
$result = $client->deleteConfiguredTableAnalysisRule([/* ... */]); $promise = $client->deleteConfiguredTableAnalysisRuleAsync([/* ... */]);
Deletes a configured table analysis rule.
Parameter Syntax
$result = $client->deleteConfiguredTableAnalysisRule([
'analysisRuleType' => 'AGGREGATION|LIST', // REQUIRED
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- analysisRuleType
-
- Required: Yes
- Type: string
The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
Result Syntax
[]
Result Details
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteConfiguredTableAssociation
$result = $client->deleteConfiguredTableAssociation([/* ... */]); $promise = $client->deleteConfiguredTableAssociationAsync([/* ... */]);
Deletes a configured table association.
Parameter Syntax
$result = $client->deleteConfiguredTableAssociation([
'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
'membershipIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- configuredTableAssociationIdentifier
-
- Required: Yes
- Type: string
The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
- membershipIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
Result Syntax
[]
Result Details
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteMember
$result = $client->deleteMember([/* ... */]); $promise = $client->deleteMemberAsync([/* ... */]);
Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
Parameter Syntax
$result = $client->deleteMember([
'accountId' => '<string>', // REQUIRED
'collaborationIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- accountId
-
- Required: Yes
- Type: string
The account ID of the member to remove.
- collaborationIdentifier
-
- Required: Yes
- Type: string
The unique identifier for the associated collaboration.
Result Syntax
[]
Result Details
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
DeleteMembership
$result = $client->deleteMembership([/* ... */]); $promise = $client->deleteMembershipAsync([/* ... */]);
Deletes a specified membership. All resources under a membership must be deleted.
Parameter Syntax
$result = $client->deleteMembership([
'membershipIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
The identifier for a membership resource.
Result Syntax
[]
Result Details
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetCollaboration
$result = $client->getCollaboration([/* ... */]); $promise = $client->getCollaborationAsync([/* ... */]);
Returns metadata about a collaboration.
Parameter Syntax
$result = $client->getCollaboration([
'collaborationIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
The identifier for the collaboration.
Result Syntax
[
'collaboration' => [
'arn' => '<string>',
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'creatorDisplayName' => '<string>',
'dataEncryptionMetadata' => [
'allowCleartext' => true || false,
'allowDuplicates' => true || false,
'allowJoinsOnColumnsWithDifferentNames' => true || false,
'preserveNulls' => true || false,
],
'description' => '<string>',
'id' => '<string>',
'memberStatus' => 'INVITED|ACTIVE|LEFT|REMOVED',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'queryLogStatus' => 'ENABLED|DISABLED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- collaboration
-
- Required: Yes
- Type: Collaboration structure
The entire collaboration for this identifier.
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetConfiguredTable
$result = $client->getConfiguredTable([/* ... */]); $promise = $client->getConfiguredTableAsync([/* ... */]);
Retrieves a configured table.
Parameter Syntax
$result = $client->getConfiguredTable([
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The unique ID for the configured table to retrieve.
Result Syntax
[
'configuredTable' => [
'allowedColumns' => ['<string>', ...],
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'arn' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'tableReference' => [
'glue' => [
'databaseName' => '<string>',
'tableName' => '<string>',
],
],
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTable
-
- Required: Yes
- Type: ConfiguredTable structure
The retrieved configured table.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetConfiguredTableAnalysisRule
$result = $client->getConfiguredTableAnalysisRule([/* ... */]); $promise = $client->getConfiguredTableAnalysisRuleAsync([/* ... */]);
Retrieves a configured table analysis rule.
Parameter Syntax
$result = $client->getConfiguredTableAnalysisRule([
'analysisRuleType' => 'AGGREGATION|LIST', // REQUIRED
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- analysisRuleType
-
- Required: Yes
- Type: string
The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
Result Syntax
[
'analysisRule' => [
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'policy' => [
'v1' => [
'aggregation' => [
'aggregateColumns' => [
[
'columnNames' => ['<string>', ...],
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
],
// ...
],
'dimensionColumns' => ['<string>', ...],
'joinColumns' => ['<string>', ...],
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [
[
'columnName' => '<string>',
'minimum' => <integer>,
'type' => 'COUNT_DISTINCT',
],
// ...
],
'scalarFunctions' => ['<string>', ...],
],
'list' => [
'joinColumns' => ['<string>', ...],
'listColumns' => ['<string>', ...],
],
],
],
'type' => 'AGGREGATION|LIST',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- analysisRule
-
- Required: Yes
- Type: ConfiguredTableAnalysisRule structure
The entire analysis rule output.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetConfiguredTableAssociation
$result = $client->getConfiguredTableAssociation([/* ... */]); $promise = $client->getConfiguredTableAssociationAsync([/* ... */]);
Retrieves a configured table association.
Parameter Syntax
$result = $client->getConfiguredTableAssociation([
'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
'membershipIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- configuredTableAssociationIdentifier
-
- Required: Yes
- Type: string
The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
- membershipIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
Result Syntax
[
'configuredTableAssociation' => [
'arn' => '<string>',
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'roleArn' => '<string>',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTableAssociation
-
- Required: Yes
- Type: ConfiguredTableAssociation structure
The entire configured table association object.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetMembership
$result = $client->getMembership([/* ... */]); $promise = $client->getMembershipAsync([/* ... */]);
Retrieves a specified membership for an identifier.
Parameter Syntax
$result = $client->getMembership([
'membershipIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
The identifier for a membership resource.
Result Syntax
[
'membership' => [
'arn' => '<string>',
'collaborationArn' => '<string>',
'collaborationCreatorAccountId' => '<string>',
'collaborationCreatorDisplayName' => '<string>',
'collaborationId' => '<string>',
'collaborationName' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'memberAbilities' => ['<string>', ...],
'queryLogStatus' => 'ENABLED|DISABLED',
'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- membership
-
- Required: Yes
- Type: Membership structure
The membership retrieved for the provided identifier.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetProtectedQuery
$result = $client->getProtectedQuery([/* ... */]); $promise = $client->getProtectedQueryAsync([/* ... */]);
Returns query processing metadata.
Parameter Syntax
$result = $client->getProtectedQuery([
'membershipIdentifier' => '<string>', // REQUIRED
'protectedQueryIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
The identifier for a membership in a protected query instance.
- protectedQueryIdentifier
-
- Required: Yes
- Type: string
The identifier for a protected query instance.
Result Syntax
[
'protectedQuery' => [
'createTime' => <DateTime>,
'error' => [
'code' => '<string>',
'message' => '<string>',
],
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'result' => [
'output' => [
's3' => [
'location' => '<string>',
],
],
],
'resultConfiguration' => [
'outputConfiguration' => [
's3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'resultFormat' => 'CSV|PARQUET',
],
],
],
'sqlParameters' => [
'queryString' => '<string>',
],
'statistics' => [
'totalDurationInMillis' => <integer>,
],
'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
],
]
Result Details
Members
- protectedQuery
-
- Required: Yes
- Type: ProtectedQuery structure
The query processing metadata.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetSchema
$result = $client->getSchema([/* ... */]); $promise = $client->getSchemaAsync([/* ... */]);
Retrieves the schema for a relation within a collaboration.
Parameter Syntax
$result = $client->getSchema([
'collaborationIdentifier' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- name
-
- Required: Yes
- Type: string
The name of the relation to retrieve the schema for.
Result Syntax
[
'schema' => [
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'collaborationArn' => '<string>',
'collaborationId' => '<string>',
'columns' => [
[
'name' => '<string>',
'type' => '<string>',
],
// ...
],
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'description' => '<string>',
'name' => '<string>',
'partitionKeys' => [
[
'name' => '<string>',
'type' => '<string>',
],
// ...
],
'type' => 'TABLE',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- schema
-
- Required: Yes
- Type: Schema structure
The entire schema object.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
GetSchemaAnalysisRule
$result = $client->getSchemaAnalysisRule([/* ... */]); $promise = $client->getSchemaAnalysisRuleAsync([/* ... */]);
Retrieves a schema analysis rule.
Parameter Syntax
$result = $client->getSchemaAnalysisRule([
'collaborationIdentifier' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'type' => 'AGGREGATION|LIST', // REQUIRED
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- name
-
- Required: Yes
- Type: string
The name of the schema to retrieve the analysis rule for.
- type
-
- Required: Yes
- Type: string
The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
Result Syntax
[
'analysisRule' => [
'collaborationId' => '<string>',
'createTime' => <DateTime>,
'name' => '<string>',
'policy' => [
'v1' => [
'aggregation' => [
'aggregateColumns' => [
[
'columnNames' => ['<string>', ...],
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
],
// ...
],
'dimensionColumns' => ['<string>', ...],
'joinColumns' => ['<string>', ...],
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [
[
'columnName' => '<string>',
'minimum' => <integer>,
'type' => 'COUNT_DISTINCT',
],
// ...
],
'scalarFunctions' => ['<string>', ...],
],
'list' => [
'joinColumns' => ['<string>', ...],
'listColumns' => ['<string>', ...],
],
],
],
'type' => 'AGGREGATION|LIST',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- analysisRule
-
- Required: Yes
- Type: AnalysisRule structure
A specification about how data from the configured table can be used.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListCollaborations
$result = $client->listCollaborations([/* ... */]); $promise = $client->listCollaborationsAsync([/* ... */]);
Lists collaborations the caller owns, is active in, or has been invited to.
Parameter Syntax
$result = $client->listCollaborations([
'maxResults' => <integer>,
'memberStatus' => 'INVITED|ACTIVE',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- memberStatus
-
- Type: string
The caller's status in a collaboration.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[
'collaborationList' => [
[
'arn' => '<string>',
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'creatorDisplayName' => '<string>',
'id' => '<string>',
'memberStatus' => 'INVITED|ACTIVE|LEFT|REMOVED',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- collaborationList
-
- Required: Yes
- Type: Array of CollaborationSummary structures
The list of collaborations.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListConfiguredTableAssociations
$result = $client->listConfiguredTableAssociations([/* ... */]); $promise = $client->listConfiguredTableAssociationsAsync([/* ... */]);
Lists configured table associations for a membership.
Parameter Syntax
$result = $client->listConfiguredTableAssociations([
'maxResults' => <integer>,
'membershipIdentifier' => '<string>', // REQUIRED
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- membershipIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[
'configuredTableAssociationSummaries' => [
[
'arn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- configuredTableAssociationSummaries
-
- Required: Yes
- Type: Array of ConfiguredTableAssociationSummary structures
The retrieved list of configured table associations.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListConfiguredTables
$result = $client->listConfiguredTables([/* ... */]); $promise = $client->listConfiguredTablesAsync([/* ... */]);
Lists configured tables.
Parameter Syntax
$result = $client->listConfiguredTables([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[
'configuredTableSummaries' => [
[
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'arn' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'name' => '<string>',
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- configuredTableSummaries
-
- Required: Yes
- Type: Array of ConfiguredTableSummary structures
The configured tables listed by the request.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListMembers
$result = $client->listMembers([/* ... */]); $promise = $client->listMembersAsync([/* ... */]);
Lists all members within a collaboration.
Parameter Syntax
$result = $client->listMembers([
'collaborationIdentifier' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
The identifier of the collaboration in which the members are listed.
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Result Syntax
[
'memberSummaries' => [
[
'abilities' => ['<string>', ...],
'accountId' => '<string>',
'createTime' => <DateTime>,
'displayName' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'status' => 'INVITED|ACTIVE|LEFT|REMOVED',
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- memberSummaries
-
- Required: Yes
- Type: Array of MemberSummary structures
The list of members returned by the ListMembers operation.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListMemberships
$result = $client->listMemberships([/* ... */]); $promise = $client->listMembershipsAsync([/* ... */]);
Lists all memberships resources within the caller's account.
Parameter Syntax
$result = $client->listMemberships([
'maxResults' => <integer>,
'nextToken' => '<string>',
'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- status
-
- Type: string
A filter which will return only memberships in the specified status.
Result Syntax
[
'membershipSummaries' => [
[
'arn' => '<string>',
'collaborationArn' => '<string>',
'collaborationCreatorAccountId' => '<string>',
'collaborationCreatorDisplayName' => '<string>',
'collaborationId' => '<string>',
'collaborationName' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'memberAbilities' => ['<string>', ...],
'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
'updateTime' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- membershipSummaries
-
- Required: Yes
- Type: Array of MembershipSummary structures
The list of memberships returned from the ListMemberships operation.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListProtectedQueries
$result = $client->listProtectedQueries([/* ... */]); $promise = $client->listProtectedQueriesAsync([/* ... */]);
Lists protected queries, sorted by the most recent query.
Parameter Syntax
$result = $client->listProtectedQueries([
'maxResults' => <integer>,
'membershipIdentifier' => '<string>', // REQUIRED
'nextToken' => '<string>',
'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
- membershipIdentifier
-
- Required: Yes
- Type: string
The identifier for the membership in the collaboration.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- status
-
- Type: string
A filter on the status of the protected query.
Result Syntax
[
'nextToken' => '<string>',
'protectedQueries' => [
[
'createTime' => <DateTime>,
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- protectedQueries
-
- Required: Yes
- Type: Array of ProtectedQuerySummary structures
A list of protected queries.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListSchemas
$result = $client->listSchemas([/* ... */]); $promise = $client->listSchemasAsync([/* ... */]);
Lists the schemas for relations within a collaboration.
Parameter Syntax
$result = $client->listSchemas([
'collaborationIdentifier' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'schemaType' => 'TABLE',
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- maxResults
-
- Type: int
The maximum size of the results that is returned per call.
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- schemaType
-
- Type: string
If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.
Result Syntax
[
'nextToken' => '<string>',
'schemaSummaries' => [
[
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'collaborationArn' => '<string>',
'collaborationId' => '<string>',
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'name' => '<string>',
'type' => 'TABLE',
'updateTime' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token value retrieved from a previous call to access the next page of results.
- schemaSummaries
-
- Required: Yes
- Type: Array of SchemaSummary structures
The retrieved list of schemas.
Errors
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists all of the tags that have been added to a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A map of objects specifying each key name and value.
Errors
-
Request references a resource which does not exist.
-
The input fails to satisfy the specified constraints.
StartProtectedQuery
$result = $client->startProtectedQuery([/* ... */]); $promise = $client->startProtectedQueryAsync([/* ... */]);
Creates a protected query that is started by AWS Clean Rooms.
Parameter Syntax
$result = $client->startProtectedQuery([
'membershipIdentifier' => '<string>', // REQUIRED
'resultConfiguration' => [ // REQUIRED
'outputConfiguration' => [ // REQUIRED
's3' => [
'bucket' => '<string>', // REQUIRED
'keyPrefix' => '<string>',
'resultFormat' => 'CSV|PARQUET', // REQUIRED
],
],
],
'sqlParameters' => [ // REQUIRED
'queryString' => '<string>', // REQUIRED
],
'type' => 'SQL', // REQUIRED
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
A unique identifier for the membership to run this query against. Currently accepts a membership ID.
- resultConfiguration
-
- Required: Yes
- Type: ProtectedQueryResultConfiguration structure
The details needed to write the query results.
- sqlParameters
-
- Required: Yes
- Type: ProtectedQuerySQLParameters structure
The protected SQL query parameters.
- type
-
- Required: Yes
- Type: string
The type of the protected query to be started.
Result Syntax
[
'protectedQuery' => [
'createTime' => <DateTime>,
'error' => [
'code' => '<string>',
'message' => '<string>',
],
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'result' => [
'output' => [
's3' => [
'location' => '<string>',
],
],
],
'resultConfiguration' => [
'outputConfiguration' => [
's3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'resultFormat' => 'CSV|PARQUET',
],
],
],
'sqlParameters' => [
'queryString' => '<string>',
],
'statistics' => [
'totalDurationInMillis' => <integer>,
],
'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
],
]
Result Details
Members
- protectedQuery
-
- Required: Yes
- Type: ProtectedQuery structure
The protected query.
Errors
-
ServiceQuotaExceededException:
Request denied because service quota has been exceeded.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Tags a resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the resource you want to tag.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A map of objects specifying each key name and value.
Result Syntax
[]
Result Details
Errors
-
Request references a resource which does not exist.
-
The input fails to satisfy the specified constraints.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag or list of tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of key names of tags to be removed.
Result Syntax
[]
Result Details
Errors
-
Request references a resource which does not exist.
-
The input fails to satisfy the specified constraints.
UpdateCollaboration
$result = $client->updateCollaboration([/* ... */]); $promise = $client->updateCollaborationAsync([/* ... */]);
Updates collaboration metadata and can only be called by the collaboration owner.
Parameter Syntax
$result = $client->updateCollaboration([
'collaborationIdentifier' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>',
]);
Parameter Details
Members
- collaborationIdentifier
-
- Required: Yes
- Type: string
The identifier for the collaboration.
- description
-
- Type: string
A description of the collaboration.
- name
-
- Type: string
A human-readable identifier provided by the collaboration owner. Display names are not unique.
Result Syntax
[
'collaboration' => [
'arn' => '<string>',
'createTime' => <DateTime>,
'creatorAccountId' => '<string>',
'creatorDisplayName' => '<string>',
'dataEncryptionMetadata' => [
'allowCleartext' => true || false,
'allowDuplicates' => true || false,
'allowJoinsOnColumnsWithDifferentNames' => true || false,
'preserveNulls' => true || false,
],
'description' => '<string>',
'id' => '<string>',
'memberStatus' => 'INVITED|ACTIVE|LEFT|REMOVED',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'queryLogStatus' => 'ENABLED|DISABLED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- collaboration
-
- Required: Yes
- Type: Collaboration structure
The entire collaboration that has been updated.
Errors
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
UpdateConfiguredTable
$result = $client->updateConfiguredTable([/* ... */]); $promise = $client->updateConfiguredTableAsync([/* ... */]);
Updates a configured table.
Parameter Syntax
$result = $client->updateConfiguredTable([
'configuredTableIdentifier' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>',
]);
Parameter Details
Members
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The identifier for the configured table to update. Currently accepts the configured table ID.
- description
-
- Type: string
A new description for the configured table.
- name
-
- Type: string
A new name for the configured table.
Result Syntax
[
'configuredTable' => [
'allowedColumns' => ['<string>', ...],
'analysisMethod' => 'DIRECT_QUERY',
'analysisRuleTypes' => ['<string>', ...],
'arn' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'tableReference' => [
'glue' => [
'databaseName' => '<string>',
'tableName' => '<string>',
],
],
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTable
-
- Required: Yes
- Type: ConfiguredTable structure
The updated configured table.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
UpdateConfiguredTableAnalysisRule
$result = $client->updateConfiguredTableAnalysisRule([/* ... */]); $promise = $client->updateConfiguredTableAnalysisRuleAsync([/* ... */]);
Updates a configured table analysis rule.
Parameter Syntax
$result = $client->updateConfiguredTableAnalysisRule([
'analysisRulePolicy' => [ // REQUIRED
'v1' => [
'aggregation' => [
'aggregateColumns' => [ // REQUIRED
[
'columnNames' => ['<string>', ...], // REQUIRED
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG', // REQUIRED
],
// ...
],
'dimensionColumns' => ['<string>', ...], // REQUIRED
'joinColumns' => ['<string>', ...], // REQUIRED
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [ // REQUIRED
[
'columnName' => '<string>', // REQUIRED
'minimum' => <integer>, // REQUIRED
'type' => 'COUNT_DISTINCT', // REQUIRED
],
// ...
],
'scalarFunctions' => ['<string>', ...], // REQUIRED
],
'list' => [
'joinColumns' => ['<string>', ...], // REQUIRED
'listColumns' => ['<string>', ...], // REQUIRED
],
],
],
'analysisRuleType' => 'AGGREGATION|LIST', // REQUIRED
'configuredTableIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- analysisRulePolicy
-
- Required: Yes
- Type: ConfiguredTableAnalysisRulePolicy structure
The new analysis rule policy for the configured table analysis rule.
- analysisRuleType
-
- Required: Yes
- Type: string
The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- configuredTableIdentifier
-
- Required: Yes
- Type: string
The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
Result Syntax
[
'analysisRule' => [
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'policy' => [
'v1' => [
'aggregation' => [
'aggregateColumns' => [
[
'columnNames' => ['<string>', ...],
'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
],
// ...
],
'dimensionColumns' => ['<string>', ...],
'joinColumns' => ['<string>', ...],
'joinRequired' => 'QUERY_RUNNER',
'outputConstraints' => [
[
'columnName' => '<string>',
'minimum' => <integer>,
'type' => 'COUNT_DISTINCT',
],
// ...
],
'scalarFunctions' => ['<string>', ...],
],
'list' => [
'joinColumns' => ['<string>', ...],
'listColumns' => ['<string>', ...],
],
],
],
'type' => 'AGGREGATION|LIST',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- analysisRule
-
- Required: Yes
- Type: ConfiguredTableAnalysisRule structure
The entire updated analysis rule.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
UpdateConfiguredTableAssociation
$result = $client->updateConfiguredTableAssociation([/* ... */]); $promise = $client->updateConfiguredTableAssociationAsync([/* ... */]);
Updates a configured table association.
Parameter Syntax
$result = $client->updateConfiguredTableAssociation([
'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
'description' => '<string>',
'membershipIdentifier' => '<string>', // REQUIRED
'roleArn' => '<string>',
]);
Parameter Details
Members
- configuredTableAssociationIdentifier
-
- Required: Yes
- Type: string
The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
- description
-
- Type: string
A new description for the configured table association.
- membershipIdentifier
-
- Required: Yes
- Type: string
The unique ID for the membership that the configured table association belongs to.
- roleArn
-
- Type: string
The service will assume this role to access catalog metadata and query the table.
Result Syntax
[
'configuredTableAssociation' => [
'arn' => '<string>',
'configuredTableArn' => '<string>',
'configuredTableId' => '<string>',
'createTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'name' => '<string>',
'roleArn' => '<string>',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- configuredTableAssociation
-
- Required: Yes
- Type: ConfiguredTableAssociation structure
The entire updated configured table association.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
UpdateMembership
$result = $client->updateMembership([/* ... */]); $promise = $client->updateMembershipAsync([/* ... */]);
Updates a membership.
Parameter Syntax
$result = $client->updateMembership([
'membershipIdentifier' => '<string>', // REQUIRED
'queryLogStatus' => 'ENABLED|DISABLED',
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
The unique identifier of the membership.
- queryLogStatus
-
- Type: string
An indicator as to whether query logging has been enabled or disabled for the collaboration.
Result Syntax
[
'membership' => [
'arn' => '<string>',
'collaborationArn' => '<string>',
'collaborationCreatorAccountId' => '<string>',
'collaborationCreatorDisplayName' => '<string>',
'collaborationId' => '<string>',
'collaborationName' => '<string>',
'createTime' => <DateTime>,
'id' => '<string>',
'memberAbilities' => ['<string>', ...],
'queryLogStatus' => 'ENABLED|DISABLED',
'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
'updateTime' => <DateTime>,
],
]
Result Details
Members
- membership
-
- Required: Yes
- Type: Membership structure
The membership object.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
UpdateProtectedQuery
$result = $client->updateProtectedQuery([/* ... */]); $promise = $client->updateProtectedQueryAsync([/* ... */]);
Updates the processing of a currently running query.
Parameter Syntax
$result = $client->updateProtectedQuery([
'membershipIdentifier' => '<string>', // REQUIRED
'protectedQueryIdentifier' => '<string>', // REQUIRED
'targetStatus' => 'CANCELLED', // REQUIRED
]);
Parameter Details
Members
- membershipIdentifier
-
- Required: Yes
- Type: string
The identifier for a member of a protected query instance.
- protectedQueryIdentifier
-
- Required: Yes
- Type: string
The identifier for a protected query instance.
- targetStatus
-
- Required: Yes
- Type: string
The target status of a query. Used to update the execution status of a currently running query.
Result Syntax
[
'protectedQuery' => [
'createTime' => <DateTime>,
'error' => [
'code' => '<string>',
'message' => '<string>',
],
'id' => '<string>',
'membershipArn' => '<string>',
'membershipId' => '<string>',
'result' => [
'output' => [
's3' => [
'location' => '<string>',
],
],
],
'resultConfiguration' => [
'outputConfiguration' => [
's3' => [
'bucket' => '<string>',
'keyPrefix' => '<string>',
'resultFormat' => 'CSV|PARQUET',
],
],
],
'sqlParameters' => [
'queryString' => '<string>',
],
'statistics' => [
'totalDurationInMillis' => <integer>,
],
'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
],
]
Result Details
Members
- protectedQuery
-
- Required: Yes
- Type: ProtectedQuery structure
The protected query output.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
Request references a resource which does not exist.
-
Unexpected error during processing of request.
-
The input fails to satisfy the specified constraints.
-
Request was denied due to request throttling.
-
Caller does not have sufficient access to perform this action.
Shapes
AccessDeniedException
Description
Caller does not have sufficient access to perform this action.
Members
- message
-
- Type: string
- reason
-
- Type: string
A reason code for the exception.
AggregateColumn
Description
Column in configured table that can be used in aggregate function in query.
Members
- columnNames
-
- Required: Yes
- Type: Array of strings
Column names in configured table of aggregate columns.
- function
-
- Required: Yes
- Type: string
Aggregation function that can be applied to aggregate column in query.
AggregationConstraint
Description
Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
Members
- columnName
-
- Required: Yes
- Type: string
Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
- minimum
-
- Required: Yes
- Type: int
The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
- type
-
- Required: Yes
- Type: string
The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
AnalysisRule
Description
A specification about how data from the configured table can be used in a query.
Members
- collaborationId
-
- Required: Yes
- Type: string
The unique ID for the associated collaboration.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the analysis rule was created.
- name
-
- Required: Yes
- Type: string
The name for the analysis rule.
- policy
-
- Required: Yes
- Type: AnalysisRulePolicy structure
A policy that describes the associated data usage limitations.
- type
-
- Required: Yes
- Type: string
The type of analysis rule. Valid values are `AGGREGATION` and `LIST`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the analysis rule was last updated.
AnalysisRuleAggregation
Description
Enables query structure and specified queries that product aggregate statistics.
Members
- aggregateColumns
-
- Required: Yes
- Type: Array of AggregateColumn structures
The columns that query runners are allowed to use in aggregation queries.
- dimensionColumns
-
- Required: Yes
- Type: Array of strings
The columns that query runners are allowed to select, group by, or filter by.
- joinColumns
-
- Required: Yes
- Type: Array of strings
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
- joinRequired
-
- Type: string
Control that requires member who runs query to do a join with their configured table and/or other configured table in query
- outputConstraints
-
- Required: Yes
- Type: Array of AggregationConstraint structures
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
- scalarFunctions
-
- Required: Yes
- Type: Array of strings
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
AnalysisRuleList
Description
A type of analysis rule that enables row-level analysis.
Members
- joinColumns
-
- Required: Yes
- Type: Array of strings
Columns that can be used to join a configured table with the table of the member who can query and another members' configured tables.
- listColumns
-
- Required: Yes
- Type: Array of strings
Columns that can be listed in the output.
AnalysisRulePolicy
Description
Controls on the query specifications that can be run on configured table..
Members
- v1
-
- Type: AnalysisRulePolicyV1 structure
Controls on the query specifications that can be run on configured table..
AnalysisRulePolicyV1
Description
Controls on the query specifications that can be run on configured table..
Members
- aggregation
-
- Type: AnalysisRuleAggregation structure
Analysis rule type that enables only aggregation queries on a configured table.
- list
-
- Type: AnalysisRuleList structure
Analysis rule type that enables only list queries on a configured table.
BatchGetSchemaError
Description
An error describing why a schema could not be fetched.
Members
- code
-
- Required: Yes
- Type: string
An error code for the error.
- message
-
- Required: Yes
- Type: string
An error message for the error.
- name
-
- Required: Yes
- Type: string
An error name for the error.
Collaboration
Description
The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
Members
- arn
-
- Required: Yes
- Type: string
The unique ARN for the collaboration.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the collaboration was created.
- creatorAccountId
-
- Required: Yes
- Type: string
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- creatorDisplayName
-
- Required: Yes
- Type: string
A display name of the collaboration creator.
- dataEncryptionMetadata
-
- Type: DataEncryptionMetadata structure
The settings for client-side encryption for cryptographic computing.
- description
-
- Type: string
A description of the collaboration provided by the collaboration owner.
- id
-
- Required: Yes
- Type: string
The unique ID for the collaboration.
- memberStatus
-
- Required: Yes
- Type: string
The status of a member in a collaboration.
- membershipArn
-
- Type: string
The unique ARN for your membership within the collaboration.
- membershipId
-
- Type: string
The unique ID for your membership within the collaboration.
- name
-
- Required: Yes
- Type: string
A human-readable identifier provided by the collaboration owner. Display names are not unique.
- queryLogStatus
-
- Required: Yes
- Type: string
An indicator as to whether query logging has been enabled or disabled for the collaboration.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the collaboration metadata was last updated.
CollaborationSummary
Description
The metadata of the collaboration.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the collaboration.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the collaboration was created.
- creatorAccountId
-
- Required: Yes
- Type: string
The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
- creatorDisplayName
-
- Required: Yes
- Type: string
The display name of the collaboration creator.
- id
-
- Required: Yes
- Type: string
The identifier for the collaboration.
- memberStatus
-
- Required: Yes
- Type: string
The status of a member in a collaboration.
- membershipArn
-
- Type: string
The ARN of a member in a collaboration.
- membershipId
-
- Type: string
The identifier of a member in a collaboration.
- name
-
- Required: Yes
- Type: string
A human-readable identifier provided by the collaboration owner. Display names are not unique.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the collaboration metadata was last updated.
Column
Description
A column within a schema relation, derived from the underlying AWS Glue table.
Members
- name
-
- Required: Yes
- Type: string
The name of the column.
- type
-
- Required: Yes
- Type: string
The type of the column.
ConfiguredTable
Description
A table that has been configured for use in a collaboration.
Members
- allowedColumns
-
- Required: Yes
- Type: Array of strings
The columns within the underlying AWS Glue table that can be utilized within collaborations.
- analysisMethod
-
- Required: Yes
- Type: string
The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
- analysisRuleTypes
-
- Required: Yes
- Type: Array of strings
The types of analysis rules associated with this configured table. Valid values are `AGGREGATION` and `LIST`. Currently, only one analysis rule may be associated with a configured table.
- arn
-
- Required: Yes
- Type: string
The unique ARN for the configured table.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table was created.
- description
-
- Type: string
A description for the configured table.
- id
-
- Required: Yes
- Type: string
The unique ID for the configured table.
- name
-
- Required: Yes
- Type: string
A name for the configured table.
- tableReference
-
- Required: Yes
- Type: TableReference structure
The AWS Glue table that this configured table represents.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table was last updated
ConfiguredTableAnalysisRule
Description
A configured table analysis rule, which limits how data for this table can be used.
Members
- configuredTableArn
-
- Required: Yes
- Type: string
The unique ARN for the configured table.
- configuredTableId
-
- Required: Yes
- Type: string
The unique ID for the configured table.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table analysis rule was created.
- policy
-
- Required: Yes
- Type: ConfiguredTableAnalysisRulePolicy structure
The policy that controls SQL query rules.
- type
-
- Required: Yes
- Type: string
The type of configured table analysis rule. Valid values are `AGGREGATION` and `LIST`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table analysis rule was last updated.
ConfiguredTableAnalysisRulePolicy
Description
Controls on the query specifications that can be run on a configured table.
Members
- v1
-
- Type: ConfiguredTableAnalysisRulePolicyV1 structure
Controls on the query specifications that can be run on a configured table.
ConfiguredTableAnalysisRulePolicyV1
Description
Controls on the query specifications that can be run on a configured table.
Members
- aggregation
-
- Type: AnalysisRuleAggregation structure
Analysis rule type that enables only aggregation queries on a configured table.
- list
-
- Type: AnalysisRuleList structure
Analysis rule type that enables only list queries on a configured table.
ConfiguredTableAssociation
Description
A configured table association links a configured table to a collaboration.
Members
- arn
-
- Required: Yes
- Type: string
The unique ARN for the configured table association.
- configuredTableArn
-
- Required: Yes
- Type: string
The unique ARN for the configured table that the association refers to.
- configuredTableId
-
- Required: Yes
- Type: string
The unique ID for the configured table that the association refers to.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table association was created.
- description
-
- Type: string
A description of the configured table association.
- id
-
- Required: Yes
- Type: string
The unique ID for the configured table association.
- membershipArn
-
- Required: Yes
- Type: string
The unique ARN for the membership this configured table association belongs to.
- membershipId
-
- Required: Yes
- Type: string
The unique ID for the membership this configured table association belongs to.
- name
-
- Required: Yes
- Type: string
The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.
- roleArn
-
- Required: Yes
- Type: string
The service will assume this role to access catalog metadata and query the table.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table association was last updated.
ConfiguredTableAssociationSummary
Description
The configured table association summary for the objects listed by the request.
Members
- arn
-
- Required: Yes
- Type: string
The unique ARN for the configured table association.
- configuredTableId
-
- Required: Yes
- Type: string
The unique configured table ID that this configured table association refers to.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table association was created.
- id
-
- Required: Yes
- Type: string
The unique ID for the configured table association.
- membershipArn
-
- Required: Yes
- Type: string
The unique ARN for the membership that the configured table association belongs to.
- membershipId
-
- Required: Yes
- Type: string
The unique ID for the membership that the configured table association belongs to.
- name
-
- Required: Yes
- Type: string
The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table association was last updated.
ConfiguredTableSummary
Description
The configured table summary for the objects listed by the request.
Members
- analysisMethod
-
- Required: Yes
- Type: string
The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
- analysisRuleTypes
-
- Required: Yes
- Type: Array of strings
The types of analysis rules associated with this configured table.
- arn
-
- Required: Yes
- Type: string
The unique ARN of the configured table.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table was created.
- id
-
- Required: Yes
- Type: string
The unique ID of the configured table.
- name
-
- Required: Yes
- Type: string
The name of the configured table.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the configured table was last updated.
ConflictException
Description
Updating or deleting a resource can cause an inconsistent state.
Members
- message
-
- Type: string
- reason
-
- Type: string
A reason code for the exception.
- resourceId
-
- Type: string
The ID of the conflicting resource.
- resourceType
-
- Type: string
The type of the conflicting resource.
DataEncryptionMetadata
Description
The settings for client-side encryption for cryptographic computing.
Members
- allowCleartext
-
- Required: Yes
- Type: boolean
Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).
- allowDuplicates
-
- Required: Yes
- Type: boolean
Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).
- allowJoinsOnColumnsWithDifferentNames
-
- Required: Yes
- Type: boolean
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).
- preserveNulls
-
- Required: Yes
- Type: boolean
Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
GlueTableReference
Description
A reference to a table within an AWS Glue data catalog.
Members
- databaseName
-
- Required: Yes
- Type: string
The name of the database the AWS Glue table belongs to.
- tableName
-
- Required: Yes
- Type: string
The name of the AWS Glue table.
InternalServerException
Description
Unexpected error during processing of request.
Members
- message
-
- Type: string
MemberSpecification
Description
Basic metadata used to construct a new member.
Members
- accountId
-
- Required: Yes
- Type: string
The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
- displayName
-
- Required: Yes
- Type: string
The member's display name.
- memberAbilities
-
- Required: Yes
- Type: Array of strings
The abilities granted to the collaboration member.
MemberSummary
Description
The member object listed by the request.
Members
- abilities
-
- Required: Yes
- Type: Array of strings
The abilities granted to the collaboration member.
- accountId
-
- Required: Yes
- Type: string
The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the member was created.
- displayName
-
- Required: Yes
- Type: string
The member's display name.
- membershipArn
-
- Type: string
The unique ARN for the member's associated membership, if present.
- membershipId
-
- Type: string
The unique ID for the member's associated membership, if present.
- status
-
- Required: Yes
- Type: string
The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the member metadata was last updated.
Membership
Description
The membership object.
Members
- arn
-
- Required: Yes
- Type: string
The unique ARN for the membership.
- collaborationArn
-
- Required: Yes
- Type: string
The unique ARN for the membership's associated collaboration.
- collaborationCreatorAccountId
-
- Required: Yes
- Type: string
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
- collaborationCreatorDisplayName
-
- Required: Yes
- Type: string
The display name of the collaboration creator.
- collaborationId
-
- Required: Yes
- Type: string
The unique ID for the membership's collaboration.
- collaborationName
-
- Required: Yes
- Type: string
The name of the membership's collaboration.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the membership was created.
- id
-
- Required: Yes
- Type: string
The unique ID of the membership.
- memberAbilities
-
- Required: Yes
- Type: Array of strings
The abilities granted to the collaboration member.
- queryLogStatus
-
- Required: Yes
- Type: string
An indicator as to whether query logging has been enabled or disabled for the collaboration.
- status
-
- Required: Yes
- Type: string
The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the membership metadata was last updated.
MembershipSummary
Description
The membership object listed by the request.
Members
- arn
-
- Required: Yes
- Type: string
The unique ARN for the membership.
- collaborationArn
-
- Required: Yes
- Type: string
The unique ARN for the membership's associated collaboration.
- collaborationCreatorAccountId
-
- Required: Yes
- Type: string
The identifier of the AWS principal that created the collaboration. Currently only supports AWS account ID.
- collaborationCreatorDisplayName
-
- Required: Yes
- Type: string
The display name of the collaboration creator.
- collaborationId
-
- Required: Yes
- Type: string
The unique ID for the membership's collaboration.
- collaborationName
-
- Required: Yes
- Type: string
The name for the membership's collaboration.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the membership was created.
- id
-
- Required: Yes
- Type: string
The unique ID for the membership's collaboration.
- memberAbilities
-
- Required: Yes
- Type: Array of strings
The abilities granted to the collaboration member.
- status
-
- Required: Yes
- Type: string
The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the membership metadata was last updated.
ProtectedQuery
Description
The parameters for an AWS Clean Rooms protected query.
Members
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the protected query was created.
- error
-
- Type: ProtectedQueryError structure
An error thrown by the protected query.
- id
-
- Required: Yes
- Type: string
The identifier for a protected query instance.
- membershipArn
-
- Required: Yes
- Type: string
The ARN of the membership.
- membershipId
-
- Required: Yes
- Type: string
The identifier for the membership.
- result
-
- Type: ProtectedQueryResult structure
The result of the protected query.
- resultConfiguration
-
- Required: Yes
- Type: ProtectedQueryResultConfiguration structure
Contains any details needed to write the query results.
- sqlParameters
-
- Required: Yes
- Type: ProtectedQuerySQLParameters structure
The protected query SQL parameters.
- statistics
-
- Type: ProtectedQueryStatistics structure
Statistics about protected query execution.
- status
-
- Required: Yes
- Type: string
The status of the query.
ProtectedQueryError
Description
Details of errors thrown by the protected query.
Members
- code
-
- Required: Yes
- Type: string
An error code for the error.
- message
-
- Required: Yes
- Type: string
A description of why the query failed.
ProtectedQueryOutput
Description
Contains details about the protected query output.
Members
- s3
-
- Type: ProtectedQueryS3Output structure
If present, the output for a protected query with an `S3` output type.
ProtectedQueryOutputConfiguration
Description
Contains configuration details for protected query output.
Members
- s3
-
- Type: ProtectedQueryS3OutputConfiguration structure
Required configuration for a protected query with an `S3` output type.
ProtectedQueryResult
Description
Details about the query results.
Members
- output
-
- Required: Yes
- Type: ProtectedQueryOutput structure
The output of the protected query.
ProtectedQueryResultConfiguration
Description
Contains configurations for protected query results.
Members
- outputConfiguration
-
- Required: Yes
- Type: ProtectedQueryOutputConfiguration structure
Configuration for protected query results.
ProtectedQueryS3Output
Description
Contains output information for protected queries with an S3 output type.
Members
- location
-
- Required: Yes
- Type: string
The S3 location of the result.
ProtectedQueryS3OutputConfiguration
Description
Contains the configuration to write the query results to S3.
Members
- bucket
-
- Required: Yes
- Type: string
The S3 bucket to unload the protected query results.
- keyPrefix
-
- Type: string
The S3 prefix to unload the protected query results.
- resultFormat
-
- Required: Yes
- Type: string
Intended file format of the result.
ProtectedQuerySQLParameters
Description
The parameters for the SQL type Protected Query.
Members
- queryString
-
- Required: Yes
- Type: string
The query string to be submitted.
ProtectedQueryStatistics
Description
Contains statistics about the execution of the protected query.
Members
- totalDurationInMillis
-
- Type: long (int|float)
The duration of the Protected Query, from creation until query completion.
ProtectedQuerySummary
Description
The protected query summary for the objects listed by the request.
Members
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the protected query was created.
- id
-
- Required: Yes
- Type: string
The unique ID of the protected query.
- membershipArn
-
- Required: Yes
- Type: string
The unique ARN for the membership that initiated the protected query.
- membershipId
-
- Required: Yes
- Type: string
The unique ID for the membership that initiated the protected query.
- status
-
- Required: Yes
- Type: string
The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
ResourceNotFoundException
Description
Request references a resource which does not exist.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The Id of the missing resource.
- resourceType
-
- Required: Yes
- Type: string
The type of the missing resource.
Schema
Description
A schema is a relation within a collaboration.
Members
- analysisMethod
-
- Type: string
The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
- analysisRuleTypes
-
- Required: Yes
- Type: Array of strings
The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
- collaborationArn
-
- Required: Yes
- Type: string
The unique ARN for the collaboration that the schema belongs to.
- collaborationId
-
- Required: Yes
- Type: string
The unique ID for the collaboration that the schema belongs to.
- columns
-
- Required: Yes
- Type: Array of Column structures
The columns for the relation this schema represents.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the schema was created.
- creatorAccountId
-
- Required: Yes
- Type: string
The unique account ID for the AWS account that owns the schema.
- description
-
- Required: Yes
- Type: string
A description for the schema.
- name
-
- Required: Yes
- Type: string
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
- partitionKeys
-
- Required: Yes
- Type: Array of Column structures
The partition keys for the dataset underlying this schema.
- type
-
- Required: Yes
- Type: string
The type of schema. The only valid value is currently `TABLE`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the schema was last updated.
SchemaSummary
Description
The schema summary for the objects listed by the request.
Members
- analysisMethod
-
- Type: string
The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
- analysisRuleTypes
-
- Required: Yes
- Type: Array of strings
The types of analysis rules that are associated with this schema object.
- collaborationArn
-
- Required: Yes
- Type: string
The unique ARN for the collaboration that the schema belongs to.
- collaborationId
-
- Required: Yes
- Type: string
The unique ID for the collaboration that the schema belongs to.
- createTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the schema object was created.
- creatorAccountId
-
- Required: Yes
- Type: string
The unique account ID for the AWS account that owns the schema.
- name
-
- Required: Yes
- Type: string
The name for the schema object.
- type
-
- Required: Yes
- Type: string
The type of schema object. The only valid schema type is currently `TABLE`.
- updateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the schema object was last updated.
ServiceQuotaExceededException
Description
Request denied because service quota has been exceeded.
Members
- message
-
- Required: Yes
- Type: string
- quotaName
-
- Required: Yes
- Type: string
The name of the quota.
- quotaValue
-
- Required: Yes
- Type: double
The value of the quota.
TableReference
Description
A pointer to the dataset that underlies this table. Currently, this can only be an AWS Glue table.
Members
- glue
-
- Type: GlueTableReference structure
If present, a reference to the AWS Glue table referred to by this table reference.
ThrottlingException
Description
Request was denied due to request throttling.
Members
- message
-
- Type: string
ValidationException
Description
The input fails to satisfy the specified constraints.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
Validation errors for specific input parameters.
- message
-
- Type: string
- reason
-
- Type: string
A reason code for the exception.
ValidationExceptionField
Description
Describes validation errors for specific input parameters.
Members
- message
-
- Required: Yes
- Type: string
A message for the input validation error.
- name
-
- Required: Yes
- Type: string
The name of the input parameter.