BatchGetCollaborationAnalysisTemplate

$result = $client->batchGetCollaborationAnalysisTemplate([/* ... */]);
$promise = $client->batchGetCollaborationAnalysisTemplateAsync([/* ... */]);

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

Parameter Syntax

$result = $client->batchGetCollaborationAnalysisTemplate([
    'analysisTemplateArns' => ['<string>', ...], // REQUIRED
    'collaborationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationAnalysisTemplates' => [
        [
            'analysisParameters' => [
                [
                    'defaultValue' => '<string>',
                    'name' => '<string>',
                    'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT',
                ],
                // ...
            ],
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'format' => 'SQL',
            'id' => '<string>',
            'name' => '<string>',
            'schema' => [
                'referencedTables' => ['<string>', ...],
            ],
            'source' => [
                'text' => '<string>',
            ],
            'updateTime' => <DateTime>,
            'validations' => [
                [
                    'reasons' => [
                        [
                            'message' => '<string>',
                        ],
                        // ...
                    ],
                    'status' => 'VALID|INVALID|UNABLE_TO_VALIDATE',
                    'type' => 'DIFFERENTIAL_PRIVACY',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'errors' => [
        [
            'arn' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

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

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>',
                ],
                // ...
            ],
            'schemaStatusDetails' => [
                [
                    'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE',
                    'analysisType' => 'DIRECT_ANALYSIS|ADDITIONAL_ANALYSIS',
                    'configurations' => ['<string>', ...],
                    'reasons' => [
                        [
                            'code' => 'ANALYSIS_RULE_MISSING|ANALYSIS_TEMPLATES_NOT_CONFIGURED|ANALYSIS_PROVIDERS_NOT_CONFIGURED|DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED|ID_MAPPING_TABLE_NOT_POPULATED|COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED|ADDITIONAL_ANALYSES_NOT_CONFIGURED|RESULT_RECEIVERS_NOT_CONFIGURED|ADDITIONAL_ANALYSES_NOT_ALLOWED|RESULT_RECEIVERS_NOT_ALLOWED|ANALYSIS_RULE_TYPES_NOT_COMPATIBLE',
                            'message' => '<string>',
                        ],
                        // ...
                    ],
                    'status' => 'READY|NOT_READY',
                ],
                // ...
            ],
            'schemaTypeProperties' => [
                'idMappingTable' => [
                    'idMappingTableInputSource' => [
                        [
                            'idNamespaceAssociationId' => '<string>',
                            'type' => 'SOURCE|TARGET',
                        ],
                        // ...
                    ],
                ],
            ],
            'type' => 'TABLE|ID_MAPPING_TABLE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

BatchGetSchemaAnalysisRule

$result = $client->batchGetSchemaAnalysisRule([/* ... */]);
$promise = $client->batchGetSchemaAnalysisRuleAsync([/* ... */]);

Retrieves multiple analysis rule schemas.

Parameter Syntax

$result = $client->batchGetSchemaAnalysisRule([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'schemaAnalysisRuleRequests' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'type' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'analysisRules' => [
        [
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'name' => '<string>',
            'policy' => [
                'v1' => [
                    'aggregation' => [
                        'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                        'aggregateColumns' => [
                            [
                                'columnNames' => ['<string>', ...],
                                'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
                            ],
                            // ...
                        ],
                        'allowedJoinOperators' => ['<string>', ...],
                        'dimensionColumns' => ['<string>', ...],
                        'joinColumns' => ['<string>', ...],
                        'joinRequired' => 'QUERY_RUNNER',
                        'outputConstraints' => [
                            [
                                'columnName' => '<string>',
                                'minimum' => <integer>,
                                'type' => 'COUNT_DISTINCT',
                            ],
                            // ...
                        ],
                        'scalarFunctions' => ['<string>', ...],
                    ],
                    'custom' => [
                        'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                        'allowedAnalyses' => ['<string>', ...],
                        'allowedAnalysisProviders' => ['<string>', ...],
                        'differentialPrivacy' => [
                            'columns' => [
                                [
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'disallowedOutputColumns' => ['<string>', ...],
                    ],
                    'idMappingTable' => [
                        'dimensionColumns' => ['<string>', ...],
                        'joinColumns' => ['<string>', ...],
                        'queryConstraints' => [
                            [
                                'requireOverlap' => [
                                    'columns' => ['<string>', ...],
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'list' => [
                        'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                        'allowedJoinOperators' => ['<string>', ...],
                        'joinColumns' => ['<string>', ...],
                        'listColumns' => ['<string>', ...],
                    ],
                ],
            ],
            'type' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'name' => '<string>',
            'type' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreateAnalysisTemplate

$result = $client->createAnalysisTemplate([/* ... */]);
$promise = $client->createAnalysisTemplateAsync([/* ... */]);

Creates a new analysis template.

Parameter Syntax

$result = $client->createAnalysisTemplate([
    'analysisParameters' => [
        [
            'defaultValue' => '<string>',
            'name' => '<string>', // REQUIRED
            'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'format' => 'SQL', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'source' => [ // REQUIRED
        'text' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'analysisTemplate' => [
        'analysisParameters' => [
            [
                'defaultValue' => '<string>',
                'name' => '<string>',
                'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT',
            ],
            // ...
        ],
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'format' => 'SQL',
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'schema' => [
            'referencedTables' => ['<string>', ...],
        ],
        'source' => [
            'text' => '<string>',
        ],
        'updateTime' => <DateTime>,
        'validations' => [
            [
                'reasons' => [
                    [
                        'message' => '<string>',
                    ],
                    // ...
                ],
                'status' => 'VALID|INVALID|UNABLE_TO_VALIDATE',
                'type' => 'DIFFERENTIAL_PRIVACY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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([
    'analyticsEngine' => 'SPARK|CLEAN_ROOMS_SQL',
    'creatorDisplayName' => '<string>', // REQUIRED
    'creatorMLMemberAbilities' => [
        'customMLMemberAbilities' => ['<string>', ...], // REQUIRED
    ],
    'creatorMemberAbilities' => ['<string>', ...], // REQUIRED
    'creatorPaymentConfiguration' => [
        'machineLearning' => [
            'modelInference' => [
                'isResponsible' => true || false, // REQUIRED
            ],
            'modelTraining' => [
                'isResponsible' => true || false, // REQUIRED
            ],
        ],
        'queryCompute' => [ // REQUIRED
            'isResponsible' => true || false, // 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
            'mlMemberAbilities' => [
                'customMLMemberAbilities' => ['<string>', ...], // REQUIRED
            ],
            'paymentConfiguration' => [
                'machineLearning' => [
                    'modelInference' => [
                        'isResponsible' => true || false, // REQUIRED
                    ],
                    'modelTraining' => [
                        'isResponsible' => true || false, // REQUIRED
                    ],
                ],
                'queryCompute' => [ // REQUIRED
                    'isResponsible' => true || false, // REQUIRED
                ],
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'queryLogStatus' => 'ENABLED|DISABLED', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'collaboration' => [
        'analyticsEngine' => 'SPARK|CLEAN_ROOMS_SQL',
        '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

Errors

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreateConfiguredAudienceModelAssociation

$result = $client->createConfiguredAudienceModelAssociation([/* ... */]);
$promise = $client->createConfiguredAudienceModelAssociationAsync([/* ... */]);

Provides the details necessary to create a configured audience model association.

Parameter Syntax

$result = $client->createConfiguredAudienceModelAssociation([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
    'configuredAudienceModelAssociationName' => '<string>', // REQUIRED
    'description' => '<string>',
    'manageResourcePolicies' => true || false, // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'configuredAudienceModelArn' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'manageResourcePolicies' => true || false,
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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
        'athena' => [
            'databaseName' => '<string>', // REQUIRED
            'outputLocation' => '<string>',
            'tableName' => '<string>', // REQUIRED
            'workGroup' => '<string>', // REQUIRED
        ],
        'glue' => [
            'databaseName' => '<string>', // REQUIRED
            'tableName' => '<string>', // REQUIRED
        ],
        'snowflake' => [
            'accountIdentifier' => '<string>', // REQUIRED
            'databaseName' => '<string>', // REQUIRED
            'schemaName' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
            'tableName' => '<string>', // REQUIRED
            'tableSchema' => [ // REQUIRED
                'v1' => [
                    [
                        'columnName' => '<string>', // REQUIRED
                        'columnType' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'configuredTable' => [
        'allowedColumns' => ['<string>', ...],
        'analysisMethod' => 'DIRECT_QUERY',
        'analysisRuleTypes' => ['<string>', ...],
        'arn' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'tableReference' => [
            'athena' => [
                'databaseName' => '<string>',
                'outputLocation' => '<string>',
                'tableName' => '<string>',
                'workGroup' => '<string>',
            ],
            'glue' => [
                'databaseName' => '<string>',
                'tableName' => '<string>',
            ],
            'snowflake' => [
                'accountIdentifier' => '<string>',
                'databaseName' => '<string>',
                'schemaName' => '<string>',
                'secretArn' => '<string>',
                'tableName' => '<string>',
                'tableSchema' => [
                    'v1' => [
                        [
                            'columnName' => '<string>',
                            'columnType' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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' => [
                'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                'aggregateColumns' => [ // REQUIRED
                    [
                        'columnNames' => ['<string>', ...], // REQUIRED
                        'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG', // REQUIRED
                    ],
                    // ...
                ],
                'allowedJoinOperators' => ['<string>', ...],
                'dimensionColumns' => ['<string>', ...], // REQUIRED
                'joinColumns' => ['<string>', ...], // REQUIRED
                'joinRequired' => 'QUERY_RUNNER',
                'outputConstraints' => [ // REQUIRED
                    [
                        'columnName' => '<string>', // REQUIRED
                        'minimum' => <integer>, // REQUIRED
                        'type' => 'COUNT_DISTINCT', // REQUIRED
                    ],
                    // ...
                ],
                'scalarFunctions' => ['<string>', ...], // REQUIRED
            ],
            'custom' => [
                'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                'allowedAnalyses' => ['<string>', ...], // REQUIRED
                'allowedAnalysisProviders' => ['<string>', ...],
                'differentialPrivacy' => [
                    'columns' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'disallowedOutputColumns' => ['<string>', ...],
            ],
            'list' => [
                'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                'allowedJoinOperators' => ['<string>', ...],
                'joinColumns' => ['<string>', ...], // REQUIRED
                'listColumns' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM', // REQUIRED
    'configuredTableIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisRule' => [
        'configuredTableArn' => '<string>',
        'configuredTableId' => '<string>',
        'createTime' => <DateTime>,
        'policy' => [
            'v1' => [
                'aggregation' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'aggregateColumns' => [
                        [
                            'columnNames' => ['<string>', ...],
                            'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
                        ],
                        // ...
                    ],
                    'allowedJoinOperators' => ['<string>', ...],
                    'dimensionColumns' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'joinRequired' => 'QUERY_RUNNER',
                    'outputConstraints' => [
                        [
                            'columnName' => '<string>',
                            'minimum' => <integer>,
                            'type' => 'COUNT_DISTINCT',
                        ],
                        // ...
                    ],
                    'scalarFunctions' => ['<string>', ...],
                ],
                'custom' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedAnalyses' => ['<string>', ...],
                    'allowedAnalysisProviders' => ['<string>', ...],
                    'differentialPrivacy' => [
                        'columns' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'disallowedOutputColumns' => ['<string>', ...],
                ],
                'list' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedJoinOperators' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'listColumns' => ['<string>', ...],
                ],
            ],
        ],
        'type' => 'AGGREGATION|LIST|CUSTOM',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'configuredTableAssociation' => [
        'analysisRuleTypes' => ['<string>', ...],
        'arn' => '<string>',
        'configuredTableArn' => '<string>',
        'configuredTableId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'roleArn' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreateConfiguredTableAssociationAnalysisRule

$result = $client->createConfiguredTableAssociationAnalysisRule([/* ... */]);
$promise = $client->createConfiguredTableAssociationAnalysisRuleAsync([/* ... */]);

Creates a new analysis rule for an associated configured table.

Parameter Syntax

$result = $client->createConfiguredTableAssociationAnalysisRule([
    'analysisRulePolicy' => [ // REQUIRED
        'v1' => [
            'aggregation' => [
                'allowedAdditionalAnalyses' => ['<string>', ...],
                'allowedResultReceivers' => ['<string>', ...],
            ],
            'custom' => [
                'allowedAdditionalAnalyses' => ['<string>', ...],
                'allowedResultReceivers' => ['<string>', ...],
            ],
            'list' => [
                'allowedAdditionalAnalyses' => ['<string>', ...],
                'allowedResultReceivers' => ['<string>', ...],
            ],
        ],
    ],
    'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM', // REQUIRED
    'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisRule' => [
        'configuredTableAssociationArn' => '<string>',
        'configuredTableAssociationId' => '<string>',
        'createTime' => <DateTime>,
        'membershipIdentifier' => '<string>',
        'policy' => [
            'v1' => [
                'aggregation' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
                'custom' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
                'list' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
            ],
        ],
        'type' => 'AGGREGATION|LIST|CUSTOM',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreateIdMappingTable

$result = $client->createIdMappingTable([/* ... */]);
$promise = $client->createIdMappingTableAsync([/* ... */]);

Creates an ID mapping table.

Parameter Syntax

$result = $client->createIdMappingTable([
    'description' => '<string>',
    'inputReferenceConfig' => [ // REQUIRED
        'inputReferenceArn' => '<string>', // REQUIRED
        'manageResourcePolicies' => true || false, // REQUIRED
    ],
    'kmsKeyArn' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'idMappingTable' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'inputReferenceConfig' => [
            'inputReferenceArn' => '<string>',
            'manageResourcePolicies' => true || false,
        ],
        'inputReferenceProperties' => [
            'idMappingTableInputSource' => [
                [
                    'idNamespaceAssociationId' => '<string>',
                    'type' => 'SOURCE|TARGET',
                ],
                // ...
            ],
        ],
        'kmsKeyArn' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreateIdNamespaceAssociation

$result = $client->createIdNamespaceAssociation([/* ... */]);
$promise = $client->createIdNamespaceAssociationAsync([/* ... */]);

Creates an ID namespace association.

Parameter Syntax

$result = $client->createIdNamespaceAssociation([
    'description' => '<string>',
    'idMappingConfig' => [
        'allowUseAsDimensionColumn' => true || false, // REQUIRED
    ],
    'inputReferenceConfig' => [ // REQUIRED
        'inputReferenceArn' => '<string>', // REQUIRED
        'manageResourcePolicies' => true || false, // REQUIRED
    ],
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'idNamespaceAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'idMappingConfig' => [
            'allowUseAsDimensionColumn' => true || false,
        ],
        'inputReferenceConfig' => [
            'inputReferenceArn' => '<string>',
            'manageResourcePolicies' => true || false,
        ],
        'inputReferenceProperties' => [
            'idMappingWorkflowsSupported' => [
                [
                ],
                // ...
            ],
            'idNamespaceType' => 'SOURCE|TARGET',
        ],
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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
    'defaultResultConfiguration' => [
        'outputConfiguration' => [ // REQUIRED
            's3' => [
                'bucket' => '<string>', // REQUIRED
                'keyPrefix' => '<string>',
                'resultFormat' => 'CSV|PARQUET', // REQUIRED
                'singleFileOutput' => true || false,
            ],
        ],
        'roleArn' => '<string>',
    ],
    'paymentConfiguration' => [
        'machineLearning' => [
            'modelInference' => [
                'isResponsible' => true || false, // REQUIRED
            ],
            'modelTraining' => [
                'isResponsible' => true || false, // REQUIRED
            ],
        ],
        'queryCompute' => [ // REQUIRED
            'isResponsible' => true || false, // REQUIRED
        ],
    ],
    'queryLogStatus' => 'ENABLED|DISABLED', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'membership' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationCreatorAccountId' => '<string>',
        'collaborationCreatorDisplayName' => '<string>',
        'collaborationId' => '<string>',
        'collaborationName' => '<string>',
        'createTime' => <DateTime>,
        'defaultResultConfiguration' => [
            'outputConfiguration' => [
                's3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'resultFormat' => 'CSV|PARQUET',
                    'singleFileOutput' => true || false,
                ],
            ],
            'roleArn' => '<string>',
        ],
        'id' => '<string>',
        'memberAbilities' => ['<string>', ...],
        'mlMemberAbilities' => [
            'customMLMemberAbilities' => ['<string>', ...],
        ],
        'paymentConfiguration' => [
            'machineLearning' => [
                'modelInference' => [
                    'isResponsible' => true || false,
                ],
                'modelTraining' => [
                    'isResponsible' => true || false,
                ],
            ],
            'queryCompute' => [
                'isResponsible' => true || false,
            ],
        ],
        'queryLogStatus' => 'ENABLED|DISABLED',
        'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

CreatePrivacyBudgetTemplate

$result = $client->createPrivacyBudgetTemplate([/* ... */]);
$promise = $client->createPrivacyBudgetTemplateAsync([/* ... */]);

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

Parameter Syntax

$result = $client->createPrivacyBudgetTemplate([
    'autoRefresh' => 'CALENDAR_MONTH|NONE', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
    'parameters' => [ // REQUIRED
        'differentialPrivacy' => [
            'epsilon' => <integer>, // REQUIRED
            'usersNoisePerQuery' => <integer>, // REQUIRED
        ],
    ],
    'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'privacyBudgetTemplate' => [
        'arn' => '<string>',
        'autoRefresh' => 'CALENDAR_MONTH|NONE',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'parameters' => [
            'differentialPrivacy' => [
                'epsilon' => <integer>,
                'usersNoisePerQuery' => <integer>,
            ],
        ],
        'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeleteAnalysisTemplate

$result = $client->deleteAnalysisTemplate([/* ... */]);
$promise = $client->deleteAnalysisTemplateAsync([/* ... */]);

Deletes an analysis template.

Parameter Syntax

$result = $client->deleteAnalysisTemplate([
    'analysisTemplateIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeleteConfiguredAudienceModelAssociation

$result = $client->deleteConfiguredAudienceModelAssociation([/* ... */]);
$promise = $client->deleteConfiguredAudienceModelAssociationAsync([/* ... */]);

Provides the information necessary to delete a configured audience model association.

Parameter Syntax

$result = $client->deleteConfiguredAudienceModelAssociation([
    'configuredAudienceModelAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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|CUSTOM', // REQUIRED
    'configuredTableIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeleteConfiguredTableAssociationAnalysisRule

$result = $client->deleteConfiguredTableAssociationAnalysisRule([/* ... */]);
$promise = $client->deleteConfiguredTableAssociationAnalysisRuleAsync([/* ... */]);

Deletes an analysis rule for a configured table association.

Parameter Syntax

$result = $client->deleteConfiguredTableAssociationAnalysisRule([
    'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM', // REQUIRED
    'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeleteIdMappingTable

$result = $client->deleteIdMappingTable([/* ... */]);
$promise = $client->deleteIdMappingTableAsync([/* ... */]);

Deletes an ID mapping table.

Parameter Syntax

$result = $client->deleteIdMappingTable([
    'idMappingTableIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeleteIdNamespaceAssociation

$result = $client->deleteIdNamespaceAssociation([/* ... */]);
$promise = $client->deleteIdNamespaceAssociationAsync([/* ... */]);

Deletes an ID namespace association.

Parameter Syntax

$result = $client->deleteIdNamespaceAssociation([
    'idNamespaceAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

DeletePrivacyBudgetTemplate

$result = $client->deletePrivacyBudgetTemplate([/* ... */]);
$promise = $client->deletePrivacyBudgetTemplateAsync([/* ... */]);

Deletes a privacy budget template for a specified membership.

Parameter Syntax

$result = $client->deletePrivacyBudgetTemplate([
    'membershipIdentifier' => '<string>', // REQUIRED
    'privacyBudgetTemplateIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetAnalysisTemplate

$result = $client->getAnalysisTemplate([/* ... */]);
$promise = $client->getAnalysisTemplateAsync([/* ... */]);

Retrieves an analysis template.

Parameter Syntax

$result = $client->getAnalysisTemplate([
    'analysisTemplateIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisTemplate' => [
        'analysisParameters' => [
            [
                'defaultValue' => '<string>',
                'name' => '<string>',
                'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT',
            ],
            // ...
        ],
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'format' => 'SQL',
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'schema' => [
            'referencedTables' => ['<string>', ...],
        ],
        'source' => [
            'text' => '<string>',
        ],
        'updateTime' => <DateTime>,
        'validations' => [
            [
                'reasons' => [
                    [
                        'message' => '<string>',
                    ],
                    // ...
                ],
                'status' => 'VALID|INVALID|UNABLE_TO_VALIDATE',
                'type' => 'DIFFERENTIAL_PRIVACY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'collaboration' => [
        'analyticsEngine' => 'SPARK|CLEAN_ROOMS_SQL',
        '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

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetCollaborationAnalysisTemplate

$result = $client->getCollaborationAnalysisTemplate([/* ... */]);
$promise = $client->getCollaborationAnalysisTemplateAsync([/* ... */]);

Retrieves an analysis template within a collaboration.

Parameter Syntax

$result = $client->getCollaborationAnalysisTemplate([
    'analysisTemplateArn' => '<string>', // REQUIRED
    'collaborationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationAnalysisTemplate' => [
        'analysisParameters' => [
            [
                'defaultValue' => '<string>',
                'name' => '<string>',
                'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT',
            ],
            // ...
        ],
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'creatorAccountId' => '<string>',
        'description' => '<string>',
        'format' => 'SQL',
        'id' => '<string>',
        'name' => '<string>',
        'schema' => [
            'referencedTables' => ['<string>', ...],
        ],
        'source' => [
            'text' => '<string>',
        ],
        'updateTime' => <DateTime>,
        'validations' => [
            [
                'reasons' => [
                    [
                        'message' => '<string>',
                    ],
                    // ...
                ],
                'status' => 'VALID|INVALID|UNABLE_TO_VALIDATE',
                'type' => 'DIFFERENTIAL_PRIVACY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetCollaborationConfiguredAudienceModelAssociation

$result = $client->getCollaborationConfiguredAudienceModelAssociation([/* ... */]);
$promise = $client->getCollaborationConfiguredAudienceModelAssociationAsync([/* ... */]);

Retrieves a configured audience model association within a collaboration.

Parameter Syntax

$result = $client->getCollaborationConfiguredAudienceModelAssociation([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'configuredAudienceModelAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationConfiguredAudienceModelAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'configuredAudienceModelArn' => '<string>',
        'createTime' => <DateTime>,
        'creatorAccountId' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetCollaborationIdNamespaceAssociation

$result = $client->getCollaborationIdNamespaceAssociation([/* ... */]);
$promise = $client->getCollaborationIdNamespaceAssociationAsync([/* ... */]);

Retrieves an ID namespace association from a specific collaboration.

Parameter Syntax

$result = $client->getCollaborationIdNamespaceAssociation([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'idNamespaceAssociationIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdNamespaceAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'creatorAccountId' => '<string>',
        'description' => '<string>',
        'id' => '<string>',
        'idMappingConfig' => [
            'allowUseAsDimensionColumn' => true || false,
        ],
        'inputReferenceConfig' => [
            'inputReferenceArn' => '<string>',
            'manageResourcePolicies' => true || false,
        ],
        'inputReferenceProperties' => [
            'idMappingWorkflowsSupported' => [
                [
                ],
                // ...
            ],
            'idNamespaceType' => 'SOURCE|TARGET',
        ],
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetCollaborationPrivacyBudgetTemplate

$result = $client->getCollaborationPrivacyBudgetTemplate([/* ... */]);
$promise = $client->getCollaborationPrivacyBudgetTemplateAsync([/* ... */]);

Returns details about a specified privacy budget template.

Parameter Syntax

$result = $client->getCollaborationPrivacyBudgetTemplate([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'privacyBudgetTemplateIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationPrivacyBudgetTemplate' => [
        'arn' => '<string>',
        'autoRefresh' => 'CALENDAR_MONTH|NONE',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'creatorAccountId' => '<string>',
        'id' => '<string>',
        'parameters' => [
            'differentialPrivacy' => [
                'epsilon' => <integer>,
                'usersNoisePerQuery' => <integer>,
            ],
        ],
        'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetConfiguredAudienceModelAssociation

$result = $client->getConfiguredAudienceModelAssociation([/* ... */]);
$promise = $client->getConfiguredAudienceModelAssociationAsync([/* ... */]);

Returns information about a configured audience model association.

Parameter Syntax

$result = $client->getConfiguredAudienceModelAssociation([
    'configuredAudienceModelAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'configuredAudienceModelArn' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'manageResourcePolicies' => true || false,
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'configuredTable' => [
        'allowedColumns' => ['<string>', ...],
        'analysisMethod' => 'DIRECT_QUERY',
        'analysisRuleTypes' => ['<string>', ...],
        'arn' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'tableReference' => [
            'athena' => [
                'databaseName' => '<string>',
                'outputLocation' => '<string>',
                'tableName' => '<string>',
                'workGroup' => '<string>',
            ],
            'glue' => [
                'databaseName' => '<string>',
                'tableName' => '<string>',
            ],
            'snowflake' => [
                'accountIdentifier' => '<string>',
                'databaseName' => '<string>',
                'schemaName' => '<string>',
                'secretArn' => '<string>',
                'tableName' => '<string>',
                'tableSchema' => [
                    'v1' => [
                        [
                            'columnName' => '<string>',
                            'columnType' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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|CUSTOM', // REQUIRED
    'configuredTableIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisRule' => [
        'configuredTableArn' => '<string>',
        'configuredTableId' => '<string>',
        'createTime' => <DateTime>,
        'policy' => [
            'v1' => [
                'aggregation' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'aggregateColumns' => [
                        [
                            'columnNames' => ['<string>', ...],
                            'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
                        ],
                        // ...
                    ],
                    'allowedJoinOperators' => ['<string>', ...],
                    'dimensionColumns' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'joinRequired' => 'QUERY_RUNNER',
                    'outputConstraints' => [
                        [
                            'columnName' => '<string>',
                            'minimum' => <integer>,
                            'type' => 'COUNT_DISTINCT',
                        ],
                        // ...
                    ],
                    'scalarFunctions' => ['<string>', ...],
                ],
                'custom' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedAnalyses' => ['<string>', ...],
                    'allowedAnalysisProviders' => ['<string>', ...],
                    'differentialPrivacy' => [
                        'columns' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'disallowedOutputColumns' => ['<string>', ...],
                ],
                'list' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedJoinOperators' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'listColumns' => ['<string>', ...],
                ],
            ],
        ],
        'type' => 'AGGREGATION|LIST|CUSTOM',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'configuredTableAssociation' => [
        'analysisRuleTypes' => ['<string>', ...],
        'arn' => '<string>',
        'configuredTableArn' => '<string>',
        'configuredTableId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'roleArn' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetConfiguredTableAssociationAnalysisRule

$result = $client->getConfiguredTableAssociationAnalysisRule([/* ... */]);
$promise = $client->getConfiguredTableAssociationAnalysisRuleAsync([/* ... */]);

Retrieves the analysis rule for a configured table association.

Parameter Syntax

$result = $client->getConfiguredTableAssociationAnalysisRule([
    'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM', // REQUIRED
    'configuredTableAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisRule' => [
        'configuredTableAssociationArn' => '<string>',
        'configuredTableAssociationId' => '<string>',
        'createTime' => <DateTime>,
        'membershipIdentifier' => '<string>',
        'policy' => [
            'v1' => [
                'aggregation' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
                'custom' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
                'list' => [
                    'allowedAdditionalAnalyses' => ['<string>', ...],
                    'allowedResultReceivers' => ['<string>', ...],
                ],
            ],
        ],
        'type' => 'AGGREGATION|LIST|CUSTOM',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetIdMappingTable

$result = $client->getIdMappingTable([/* ... */]);
$promise = $client->getIdMappingTableAsync([/* ... */]);

Retrieves an ID mapping table.

Parameter Syntax

$result = $client->getIdMappingTable([
    'idMappingTableIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'idMappingTable' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'inputReferenceConfig' => [
            'inputReferenceArn' => '<string>',
            'manageResourcePolicies' => true || false,
        ],
        'inputReferenceProperties' => [
            'idMappingTableInputSource' => [
                [
                    'idNamespaceAssociationId' => '<string>',
                    'type' => 'SOURCE|TARGET',
                ],
                // ...
            ],
        ],
        'kmsKeyArn' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetIdNamespaceAssociation

$result = $client->getIdNamespaceAssociation([/* ... */]);
$promise = $client->getIdNamespaceAssociationAsync([/* ... */]);

Retrieves an ID namespace association.

Parameter Syntax

$result = $client->getIdNamespaceAssociation([
    'idNamespaceAssociationIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'idNamespaceAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'idMappingConfig' => [
            'allowUseAsDimensionColumn' => true || false,
        ],
        'inputReferenceConfig' => [
            'inputReferenceArn' => '<string>',
            'manageResourcePolicies' => true || false,
        ],
        'inputReferenceProperties' => [
            'idMappingWorkflowsSupported' => [
                [
                ],
                // ...
            ],
            'idNamespaceType' => 'SOURCE|TARGET',
        ],
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'membership' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationCreatorAccountId' => '<string>',
        'collaborationCreatorDisplayName' => '<string>',
        'collaborationId' => '<string>',
        'collaborationName' => '<string>',
        'createTime' => <DateTime>,
        'defaultResultConfiguration' => [
            'outputConfiguration' => [
                's3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'resultFormat' => 'CSV|PARQUET',
                    'singleFileOutput' => true || false,
                ],
            ],
            'roleArn' => '<string>',
        ],
        'id' => '<string>',
        'memberAbilities' => ['<string>', ...],
        'mlMemberAbilities' => [
            'customMLMemberAbilities' => ['<string>', ...],
        ],
        'paymentConfiguration' => [
            'machineLearning' => [
                'modelInference' => [
                    'isResponsible' => true || false,
                ],
                'modelTraining' => [
                    'isResponsible' => true || false,
                ],
            ],
            'queryCompute' => [
                'isResponsible' => true || false,
            ],
        ],
        'queryLogStatus' => 'ENABLED|DISABLED',
        'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

GetPrivacyBudgetTemplate

$result = $client->getPrivacyBudgetTemplate([/* ... */]);
$promise = $client->getPrivacyBudgetTemplateAsync([/* ... */]);

Returns details for a specified privacy budget template.

Parameter Syntax

$result = $client->getPrivacyBudgetTemplate([
    'membershipIdentifier' => '<string>', // REQUIRED
    'privacyBudgetTemplateIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'privacyBudgetTemplate' => [
        'arn' => '<string>',
        'autoRefresh' => 'CALENDAR_MONTH|NONE',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'parameters' => [
            'differentialPrivacy' => [
                'epsilon' => <integer>,
                'usersNoisePerQuery' => <integer>,
            ],
        ],
        'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'protectedQuery' => [
        'computeConfiguration' => [
            'worker' => [
                'number' => <integer>,
                'type' => 'CR.1X|CR.4X',
            ],
        ],
        'createTime' => <DateTime>,
        'differentialPrivacy' => [
            'sensitivityParameters' => [
                [
                    'aggregationExpression' => '<string>',
                    'aggregationType' => 'AVG|COUNT|COUNT_DISTINCT|SUM|STDDEV',
                    'maxColumnValue' => <float>,
                    'minColumnValue' => <float>,
                    'userContributionLimit' => <integer>,
                ],
                // ...
            ],
        ],
        'error' => [
            'code' => '<string>',
            'message' => '<string>',
        ],
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'result' => [
            'output' => [
                'memberList' => [
                    [
                        'accountId' => '<string>',
                    ],
                    // ...
                ],
                's3' => [
                    'location' => '<string>',
                ],
            ],
        ],
        'resultConfiguration' => [
            'outputConfiguration' => [
                'member' => [
                    'accountId' => '<string>',
                ],
                's3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'resultFormat' => 'CSV|PARQUET',
                    'singleFileOutput' => true || false,
                ],
            ],
        ],
        'sqlParameters' => [
            'analysisTemplateArn' => '<string>',
            'parameters' => ['<string>', ...],
            'queryString' => '<string>',
        ],
        'statistics' => [
            'billedResourceUtilization' => [
                'units' => <float>,
            ],
            'totalDurationInMillis' => <integer>,
        ],
        'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

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>',
            ],
            // ...
        ],
        'schemaStatusDetails' => [
            [
                'analysisRuleType' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE',
                'analysisType' => 'DIRECT_ANALYSIS|ADDITIONAL_ANALYSIS',
                'configurations' => ['<string>', ...],
                'reasons' => [
                    [
                        'code' => 'ANALYSIS_RULE_MISSING|ANALYSIS_TEMPLATES_NOT_CONFIGURED|ANALYSIS_PROVIDERS_NOT_CONFIGURED|DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED|ID_MAPPING_TABLE_NOT_POPULATED|COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED|ADDITIONAL_ANALYSES_NOT_CONFIGURED|RESULT_RECEIVERS_NOT_CONFIGURED|ADDITIONAL_ANALYSES_NOT_ALLOWED|RESULT_RECEIVERS_NOT_ALLOWED|ANALYSIS_RULE_TYPES_NOT_COMPATIBLE',
                        'message' => '<string>',
                    ],
                    // ...
                ],
                'status' => 'READY|NOT_READY',
            ],
            // ...
        ],
        'schemaTypeProperties' => [
            'idMappingTable' => [
                'idMappingTableInputSource' => [
                    [
                        'idNamespaceAssociationId' => '<string>',
                        'type' => 'SOURCE|TARGET',
                    ],
                    // ...
                ],
            ],
        ],
        'type' => 'TABLE|ID_MAPPING_TABLE',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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|CUSTOM|ID_MAPPING_TABLE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisRule' => [
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'name' => '<string>',
        'policy' => [
            'v1' => [
                'aggregation' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'aggregateColumns' => [
                        [
                            'columnNames' => ['<string>', ...],
                            'function' => 'SUM|SUM_DISTINCT|COUNT|COUNT_DISTINCT|AVG',
                        ],
                        // ...
                    ],
                    'allowedJoinOperators' => ['<string>', ...],
                    'dimensionColumns' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'joinRequired' => 'QUERY_RUNNER',
                    'outputConstraints' => [
                        [
                            'columnName' => '<string>',
                            'minimum' => <integer>,
                            'type' => 'COUNT_DISTINCT',
                        ],
                        // ...
                    ],
                    'scalarFunctions' => ['<string>', ...],
                ],
                'custom' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedAnalyses' => ['<string>', ...],
                    'allowedAnalysisProviders' => ['<string>', ...],
                    'differentialPrivacy' => [
                        'columns' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'disallowedOutputColumns' => ['<string>', ...],
                ],
                'idMappingTable' => [
                    'dimensionColumns' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'queryConstraints' => [
                        [
                            'requireOverlap' => [
                                'columns' => ['<string>', ...],
                            ],
                        ],
                        // ...
                    ],
                ],
                'list' => [
                    'additionalAnalyses' => 'ALLOWED|REQUIRED|NOT_ALLOWED',
                    'allowedJoinOperators' => ['<string>', ...],
                    'joinColumns' => ['<string>', ...],
                    'listColumns' => ['<string>', ...],
                ],
            ],
        ],
        'type' => 'AGGREGATION|LIST|CUSTOM|ID_MAPPING_TABLE',
        'updateTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListAnalysisTemplates

$result = $client->listAnalysisTemplates([/* ... */]);
$promise = $client->listAnalysisTemplatesAsync([/* ... */]);

Lists analysis templates that the caller owns.

Parameter Syntax

$result = $client->listAnalysisTemplates([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'analysisTemplateSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListCollaborationAnalysisTemplates

$result = $client->listCollaborationAnalysisTemplates([/* ... */]);
$promise = $client->listCollaborationAnalysisTemplatesAsync([/* ... */]);

Lists analysis templates within a collaboration.

Parameter Syntax

$result = $client->listCollaborationAnalysisTemplates([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationAnalysisTemplateSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListCollaborationConfiguredAudienceModelAssociations

$result = $client->listCollaborationConfiguredAudienceModelAssociations([/* ... */]);
$promise = $client->listCollaborationConfiguredAudienceModelAssociationsAsync([/* ... */]);

Lists configured audience model associations within a collaboration.

Parameter Syntax

$result = $client->listCollaborationConfiguredAudienceModelAssociations([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationConfiguredAudienceModelAssociationSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListCollaborationIdNamespaceAssociations

$result = $client->listCollaborationIdNamespaceAssociations([/* ... */]);
$promise = $client->listCollaborationIdNamespaceAssociationsAsync([/* ... */]);

Returns a list of the ID namespace associations in a collaboration.

Parameter Syntax

$result = $client->listCollaborationIdNamespaceAssociations([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationIdNamespaceAssociationSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'id' => '<string>',
            'inputReferenceConfig' => [
                'inputReferenceArn' => '<string>',
                'manageResourcePolicies' => true || false,
            ],
            'inputReferenceProperties' => [
                'idNamespaceType' => 'SOURCE|TARGET',
            ],
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListCollaborationPrivacyBudgetTemplates

$result = $client->listCollaborationPrivacyBudgetTemplates([/* ... */]);
$promise = $client->listCollaborationPrivacyBudgetTemplatesAsync([/* ... */]);

Returns an array that summarizes each privacy budget template in a specified collaboration.

Parameter Syntax

$result = $client->listCollaborationPrivacyBudgetTemplates([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationPrivacyBudgetTemplateSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'id' => '<string>',
            'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListCollaborationPrivacyBudgets

$result = $client->listCollaborationPrivacyBudgets([/* ... */]);
$promise = $client->listCollaborationPrivacyBudgetsAsync([/* ... */]);

Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

Parameter Syntax

$result = $client->listCollaborationPrivacyBudgets([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationPrivacyBudgetSummaries' => [
        [
            'budget' => [
                'differentialPrivacy' => [
                    'aggregations' => [
                        [
                            'maxCount' => <integer>,
                            'remainingCount' => <integer>,
                            'type' => 'AVG|COUNT|COUNT_DISTINCT|SUM|STDDEV',
                        ],
                        // ...
                    ],
                    'epsilon' => <integer>,
                ],
            ],
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'id' => '<string>',
            'privacyBudgetTemplateArn' => '<string>',
            'privacyBudgetTemplateId' => '<string>',
            'type' => 'DIFFERENTIAL_PRIVACY',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'collaborationList' => [
        [
            'analyticsEngine' => 'SPARK|CLEAN_ROOMS_SQL',
            '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

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListConfiguredAudienceModelAssociations

$result = $client->listConfiguredAudienceModelAssociations([/* ... */]);
$promise = $client->listConfiguredAudienceModelAssociationsAsync([/* ... */]);

Lists information about requested configured audience model associations.

Parameter Syntax

$result = $client->listConfiguredAudienceModelAssociations([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelAssociationSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'configuredAudienceModelArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'configuredTableAssociationSummaries' => [
        [
            'arn' => '<string>',
            'configuredTableId' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'configuredTableSummaries' => [
        [
            'analysisMethod' => 'DIRECT_QUERY',
            'analysisRuleTypes' => ['<string>', ...],
            'arn' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListIdMappingTables

$result = $client->listIdMappingTables([/* ... */]);
$promise = $client->listIdMappingTablesAsync([/* ... */]);

Returns a list of ID mapping tables.

Parameter Syntax

$result = $client->listIdMappingTables([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'idMappingTableSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'inputReferenceConfig' => [
                'inputReferenceArn' => '<string>',
                'manageResourcePolicies' => true || false,
            ],
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListIdNamespaceAssociations

$result = $client->listIdNamespaceAssociations([/* ... */]);
$promise = $client->listIdNamespaceAssociationsAsync([/* ... */]);

Returns a list of ID namespace associations.

Parameter Syntax

$result = $client->listIdNamespaceAssociations([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'idNamespaceAssociationSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'inputReferenceConfig' => [
                'inputReferenceArn' => '<string>',
                'manageResourcePolicies' => true || false,
            ],
            'inputReferenceProperties' => [
                'idNamespaceType' => 'SOURCE|TARGET',
            ],
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'memberSummaries' => [
        [
            'abilities' => ['<string>', ...],
            'accountId' => '<string>',
            'createTime' => <DateTime>,
            'displayName' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'mlAbilities' => [
                'customMLMemberAbilities' => ['<string>', ...],
            ],
            'paymentConfiguration' => [
                'machineLearning' => [
                    'modelInference' => [
                        'isResponsible' => true || false,
                    ],
                    'modelTraining' => [
                        'isResponsible' => true || false,
                    ],
                ],
                'queryCompute' => [
                    'isResponsible' => true || false,
                ],
            ],
            'status' => 'INVITED|ACTIVE|LEFT|REMOVED',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'membershipSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationCreatorAccountId' => '<string>',
            'collaborationCreatorDisplayName' => '<string>',
            'collaborationId' => '<string>',
            'collaborationName' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'memberAbilities' => ['<string>', ...],
            'mlMemberAbilities' => [
                'customMLMemberAbilities' => ['<string>', ...],
            ],
            'paymentConfiguration' => [
                'machineLearning' => [
                    'modelInference' => [
                        'isResponsible' => true || false,
                    ],
                    'modelTraining' => [
                        'isResponsible' => true || false,
                    ],
                ],
                'queryCompute' => [
                    'isResponsible' => true || false,
                ],
            ],
            'status' => 'ACTIVE|REMOVED|COLLABORATION_DELETED',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListPrivacyBudgetTemplates

$result = $client->listPrivacyBudgetTemplates([/* ... */]);
$promise = $client->listPrivacyBudgetTemplatesAsync([/* ... */]);

Returns detailed information about the privacy budget templates in a specified membership.

Parameter Syntax

$result = $client->listPrivacyBudgetTemplates([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'privacyBudgetTemplateSummaries' => [
        [
            'arn' => '<string>',
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

ListPrivacyBudgets

$result = $client->listPrivacyBudgets([/* ... */]);
$promise = $client->listPrivacyBudgetsAsync([/* ... */]);

Returns detailed information about the privacy budgets in a specified membership.

Parameter Syntax

$result = $client->listPrivacyBudgets([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'privacyBudgetType' => 'DIFFERENTIAL_PRIVACY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'privacyBudgetSummaries' => [
        [
            'budget' => [
                'differentialPrivacy' => [
                    'aggregations' => [
                        [
                            'maxCount' => <integer>,
                            'remainingCount' => <integer>,
                            'type' => 'AVG|COUNT|COUNT_DISTINCT|SUM|STDDEV',
                        ],
                        // ...
                    ],
                    'epsilon' => <integer>,
                ],
            ],
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'privacyBudgetTemplateArn' => '<string>',
            'privacyBudgetTemplateId' => '<string>',
            'type' => 'DIFFERENTIAL_PRIVACY',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'protectedQueries' => [
        [
            'createTime' => <DateTime>,
            'id' => '<string>',
            'membershipArn' => '<string>',
            'membershipId' => '<string>',
            'receiverConfigurations' => [
                [
                    'analysisType' => 'DIRECT_ANALYSIS|ADDITIONAL_ANALYSIS',
                    'configurationDetails' => [
                        'directAnalysisConfigurationDetails' => [
                            'receiverAccountIds' => ['<string>', ...],
                        ],
                    ],
                ],
                // ...
            ],
            'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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|ID_MAPPING_TABLE',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'schemaSummaries' => [
        [
            'analysisMethod' => 'DIRECT_QUERY',
            'analysisRuleTypes' => ['<string>', ...],
            'collaborationArn' => '<string>',
            'collaborationId' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'name' => '<string>',
            'type' => 'TABLE|ID_MAPPING_TABLE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

ValidationException:

The input fails to satisfy the specified constraints.

PopulateIdMappingTable

$result = $client->populateIdMappingTable([/* ... */]);
$promise = $client->populateIdMappingTableAsync([/* ... */]);

Defines the information that's necessary to populate an ID mapping table.

Parameter Syntax

$result = $client->populateIdMappingTable([
    'idMappingTableIdentifier' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'idMappingJobId' => '<string>',
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

PreviewPrivacyImpact

$result = $client->previewPrivacyImpact([/* ... */]);
$promise = $client->previewPrivacyImpactAsync([/* ... */]);

An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.

Parameter Syntax

$result = $client->previewPrivacyImpact([
    'membershipIdentifier' => '<string>', // REQUIRED
    'parameters' => [ // REQUIRED
        'differentialPrivacy' => [
            'epsilon' => <integer>, // REQUIRED
            'usersNoisePerQuery' => <integer>, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'privacyImpact' => [
        'differentialPrivacy' => [
            'aggregations' => [
                [
                    'maxCount' => <integer>,
                    'type' => 'AVG|COUNT|COUNT_DISTINCT|SUM|STDDEV',
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

StartProtectedQuery

$result = $client->startProtectedQuery([/* ... */]);
$promise = $client->startProtectedQueryAsync([/* ... */]);

Creates a protected query that is started by Clean Rooms.

Parameter Syntax

$result = $client->startProtectedQuery([
    'computeConfiguration' => [
        'worker' => [
            'number' => <integer>,
            'type' => 'CR.1X|CR.4X',
        ],
    ],
    'membershipIdentifier' => '<string>', // REQUIRED
    'resultConfiguration' => [
        'outputConfiguration' => [ // REQUIRED
            'member' => [
                'accountId' => '<string>', // REQUIRED
            ],
            's3' => [
                'bucket' => '<string>', // REQUIRED
                'keyPrefix' => '<string>',
                'resultFormat' => 'CSV|PARQUET', // REQUIRED
                'singleFileOutput' => true || false,
            ],
        ],
    ],
    'sqlParameters' => [ // REQUIRED
        'analysisTemplateArn' => '<string>',
        'parameters' => ['<string>', ...],
        'queryString' => '<string>',
    ],
    'type' => 'SQL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'protectedQuery' => [
        'computeConfiguration' => [
            'worker' => [
                'number' => <integer>,
                'type' => 'CR.1X|CR.4X',
            ],
        ],
        'createTime' => <DateTime>,
        'differentialPrivacy' => [
            'sensitivityParameters' => [
                [
                    'aggregationExpression' => '<string>',
                    'aggregationType' => 'AVG|COUNT|COUNT_DISTINCT|SUM|STDDEV',
                    'maxColumnValue' => <float>,
                    'minColumnValue' => <float>,
                    'userContributionLimit' => <integer>,
                ],
                // ...
            ],
        ],
        'error' => [
            'code' => '<string>',
            'message' => '<string>',
        ],
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'result' => [
            'output' => [
                'memberList' => [
                    [
                        'accountId' => '<string>',
                    ],
                    // ...
                ],
                's3' => [
                    'location' => '<string>',
                ],
            ],
        ],
        'resultConfiguration' => [
            'outputConfiguration' => [
                'member' => [
                    'accountId' => '<string>',
                ],
                's3' => [
                    'bucket' => '<string>',
                    'keyPrefix' => '<string>',
                    'resultFormat' => 'CSV|PARQUET',
                    'singleFileOutput' => true || false,
                ],
            ],
        ],
        'sqlParameters' => [
            'analysisTemplateArn' => '<string>',
            'parameters' => ['<string>', ...],
            'queryString' => '<string>',
        ],
        'statistics' => [
            'billedResourceUtilization' => [
                'units' => <float>,
            ],
            'totalDurationInMillis' => <integer>,
        ],
        'status' => 'SUBMITTED|STARTED|CANCELLED|CANCELLING|FAILED|SUCCESS|TIMED_OUT',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

Request denied because service quota has been exceeded.

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

ValidationException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

ValidationException:

The input fails to satisfy the specified constraints.

UpdateAnalysisTemplate

$result = $client->updateAnalysisTemplate([/* ... */]);
$promise = $client->updateAnalysisTemplateAsync([/* ... */]);

Updates the analysis template metadata.

Parameter Syntax

$result = $client->updateAnalysisTemplate([
    'analysisTemplateIdentifier' => '<string>', // REQUIRED
    'description' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'analysisTemplate' => [
        'analysisParameters' => [
            [
                'defaultValue' => '<string>',
                'name' => '<string>',
                'type' => 'SMALLINT|INTEGER|BIGINT|DECIMAL|REAL|DOUBLE_PRECISION|BOOLEAN|CHAR|VARCHAR|DATE|TIMESTAMP|TIMESTAMPTZ|TIME|TIMETZ|VARBYTE|BINARY|BYTE|CHARACTER|DOUBLE|FLOAT|INT|LONG|NUMERIC|SHORT|STRING|TIMESTAMP_LTZ|TIMESTAMP_NTZ|TINYINT',
            ],
            // ...
        ],
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'format' => 'SQL',
        'id' => '<string>',
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'schema' => [
            'referencedTables' => ['<string>', ...],
        ],
        'source' => [
            'text' => '<string>',
        ],
        'updateTime' => <DateTime>,
        'validations' => [
            [
                'reasons' => [
                    [
                        'message' => '<string>',
                    ],
                    // ...
                ],
                'status' => 'VALID|INVALID|UNABLE_TO_VALIDATE',
                'type' => 'DIFFERENTIAL_PRIVACY',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Request references a resource which does not exist.

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

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

Result Syntax

[
    'collaboration' => [
        'analyticsEngine' => 'SPARK|CLEAN_ROOMS_SQL',
        '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

Errors

InternalServerException:

Unexpected error during processing of request.

ValidationException:

The input fails to satisfy the specified constraints.

ThrottlingException:

Request was denied due to request throttling.

AccessDeniedException:

Caller does not have sufficient access to perform this action.

UpdateConfiguredAudienceModelAssociation

$result = $client->updateConfiguredAudienceModelAssociation([/* ... */]);
$promise = $client->updateConfiguredAudienceModelAssociationAsync([/* ... */]);

Provides the details necessary to update a configured audience model association.

Parameter Syntax

$result = $client->updateConfiguredAudienceModelAssociation([
    'configuredAudienceModelAssociationIdentifier' => '<string>', // REQUIRED
    'description' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelAssociation' => [
        'arn' => '<string>',
        'collaborationArn' => '<string>',
        'collaborationId' => '<string>',
        'configuredAudienceModelArn' => '<string>',
        'createTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'manageResourcePolicies' => true || false,
        'membershipArn' => '<string>',
        'membershipId' => '<string>',
        'name' => '<string>',
        'updateTime' => <DateTime>,
    ],
]

Result Details