SDK for PHP V3
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 */).
- BatchGetCollaborationAnalysisTemplate ( array $params = [] )
- Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
- BatchGetSchema ( array $params = [] )
- Retrieves multiple schemas by their identifiers.
- BatchGetSchemaAnalysisRule ( array $params = [] )
- Retrieves multiple analysis rule schemas.
- CreateAnalysisTemplate ( array $params = [] )
- Creates a new analysis template.
- CreateCollaboration ( array $params = [] )
- Creates a new collaboration.
- CreateCollaborationChangeRequest ( array $params = [] )
- Creates a new change request to modify an existing collaboration.
- CreateConfiguredAudienceModelAssociation ( array $params = [] )
- Provides the details necessary to create a configured audience model association.
- 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.
- CreateConfiguredTableAssociationAnalysisRule ( array $params = [] )
- Creates a new analysis rule for an associated configured table.
- CreateIdMappingTable ( array $params = [] )
- Creates an ID mapping table.
- CreateIdNamespaceAssociation ( array $params = [] )
- Creates an ID namespace association.
- CreateIntermediateTable ( array $params = [] )
- Creates an intermediate table in a membership.
- CreateIntermediateTableAnalysisRule ( array $params = [] )
- Creates an analysis rule for an intermediate table.
- CreateMembership ( array $params = [] )
- Creates a membership for a specific collaboration identifier and joins the collaboration.
- CreatePrivacyBudgetTemplate ( array $params = [] )
- Creates a privacy budget template for a specified collaboration.
- DeleteAnalysisTemplate ( array $params = [] )
- Deletes an analysis template.
- DeleteCollaboration ( array $params = [] )
- Deletes a collaboration.
- DeleteConfiguredAudienceModelAssociation ( array $params = [] )
- Provides the information necessary to delete a configured audience model association.
- DeleteConfiguredTable ( array $params = [] )
- Deletes a configured table.
- DeleteConfiguredTableAnalysisRule ( array $params = [] )
- Deletes a configured table analysis rule.
- DeleteConfiguredTableAssociation ( array $params = [] )
- Deletes a configured table association.
- DeleteConfiguredTableAssociationAnalysisRule ( array $params = [] )
- Deletes an analysis rule for a configured table association.
- DeleteIdMappingTable ( array $params = [] )
- Deletes an ID mapping table.
- DeleteIdNamespaceAssociation ( array $params = [] )
- Deletes an ID namespace association.
- DeleteIntermediateTable ( array $params = [] )
- Deletes an intermediate table.
- DeleteIntermediateTableAnalysisRule ( array $params = [] )
- Deletes an analysis rule from an intermediate table.
- DeleteMember ( array $params = [] )
- Removes the specified member from a collaboration.
- DeleteMembership ( array $params = [] )
- Deletes a specified membership.
- DeletePrivacyBudgetTemplate ( array $params = [] )
- Deletes a privacy budget template for a specified collaboration.
- DisallowIntermediateTable ( array $params = [] )
- Marks an intermediate table as invalid when it references the caller's base table.
- GetAnalysisLogExport ( array $params = [] )
- Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure.
- GetAnalysisTemplate ( array $params = [] )
- Retrieves an analysis template.
- GetCollaboration ( array $params = [] )
- Returns metadata about a collaboration.
- GetCollaborationAnalysisTemplate ( array $params = [] )
- Retrieves an analysis template within a collaboration.
- GetCollaborationChangeRequest ( array $params = [] )
- Retrieves detailed information about a specific collaboration change request.
- GetCollaborationConfiguredAudienceModelAssociation ( array $params = [] )
- Retrieves a configured audience model association within a collaboration.
- GetCollaborationIdNamespaceAssociation ( array $params = [] )
- Retrieves an ID namespace association from a specific collaboration.
- GetCollaborationPrivacyBudgetTemplate ( array $params = [] )
- Returns details about a specified privacy budget template.
- GetConfiguredAudienceModelAssociation ( array $params = [] )
- Returns information about a configured audience model association.
- GetConfiguredTable ( array $params = [] )
- Retrieves a configured table.
- GetConfiguredTableAnalysisRule ( array $params = [] )
- Retrieves a configured table analysis rule.
- GetConfiguredTableAssociation ( array $params = [] )
- Retrieves a configured table association.
- GetConfiguredTableAssociationAnalysisRule ( array $params = [] )
- Retrieves the analysis rule for a configured table association.
- GetIdMappingTable ( array $params = [] )
- Retrieves an ID mapping table.
- GetIdNamespaceAssociation ( array $params = [] )
- Retrieves an ID namespace association.
- GetIntermediateTable ( array $params = [] )
- Retrieves an intermediate table.
- GetIntermediateTableAnalysisRule ( array $params = [] )
- Retrieves the analysis rule for an intermediate table.
- GetMembership ( array $params = [] )
- Retrieves a specified membership for an identifier.
- GetPrivacyBudgetTemplate ( array $params = [] )
- Returns details for a specified privacy budget template.
- GetProtectedJob ( array $params = [] )
- Returns job processing metadata.
- 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.
- ListAnalysisLogExports ( array $params = [] )
- Lists analysis log exports, sorted by the most recent export.
- ListAnalysisTemplates ( array $params = [] )
- Lists analysis templates that the caller owns.
- ListCollaborationAnalysisTemplates ( array $params = [] )
- Lists analysis templates within a collaboration.
- ListCollaborationChangeRequests ( array $params = [] )
- Lists all change requests for a collaboration with pagination support.
- ListCollaborationConfiguredAudienceModelAssociations ( array $params = [] )
- Lists configured audience model associations within a collaboration.
- ListCollaborationIdNamespaceAssociations ( array $params = [] )
- Returns a list of the ID namespace associations in a collaboration.
- ListCollaborationPrivacyBudgetTemplates ( array $params = [] )
- Returns an array that summarizes each privacy budget template in a specified collaboration.
- ListCollaborationPrivacyBudgets ( array $params = [] )
- Returns an array that summarizes each privacy budget in a specified collaboration.
- ListCollaborations ( array $params = [] )
- Lists collaborations the caller owns, is active in, or has been invited to.
- ListConfiguredAudienceModelAssociations ( array $params = [] )
- Lists information about requested configured audience model associations.
- ListConfiguredTableAssociations ( array $params = [] )
- Lists configured table associations for a membership.
- ListConfiguredTables ( array $params = [] )
- Lists configured tables.
- ListIdMappingTables ( array $params = [] )
- Returns a list of ID mapping tables.
- ListIdNamespaceAssociations ( array $params = [] )
- Returns a list of ID namespace associations.
- ListIntermediateTableVersions ( array $params = [] )
- Lists the version history of an intermediate table.
- ListIntermediateTables ( array $params = [] )
- Lists intermediate tables owned by the caller in a membership.
- ListMembers ( array $params = [] )
- Lists all members within a collaboration.
- ListMemberships ( array $params = [] )
- Lists all memberships resources within the caller's account.
- ListPrivacyBudgetTemplates ( array $params = [] )
- Returns detailed information about the privacy budget templates in a specified membership.
- ListPrivacyBudgets ( array $params = [] )
- Returns detailed information about the privacy budgets in a specified membership.
- ListProtectedJobs ( array $params = [] )
- Lists protected jobs, sorted by most recent job.
- 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.
- PopulateIdMappingTable ( array $params = [] )
- Defines the information that's necessary to populate an ID mapping table.
- PopulateIntermediateTable ( array $params = [] )
- Runs the stored query of an intermediate table and makes the results available for querying.
- PreviewPrivacyImpact ( array $params = [] )
- An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
- StartAnalysisLogExport ( array $params = [] )
- Starts an export of the Apache Spark logs for a protected query to an Amazon S3 bucket that you own.
- StartProtectedJob ( array $params = [] )
- Creates a protected job that is started by Clean Rooms.
- StartProtectedQuery ( array $params = [] )
- Creates a protected query that is started by Clean Rooms.
- TagResource ( array $params = [] )
- Tags a resource.