2024/07/23 - AWS Clean Rooms Service - 13 new5 updated api methods
Changes This release adds AWS Entity Resolution integration to associate ID namespaces & ID mapping workflow resources as part of ID namespace association and ID mapping table in AWS Clean Rooms. It also introduces a new ID_MAPPING_TABLE analysis rule to manage the protection on ID mapping table.
Provides the details that are necessary to update an ID mapping table.
See also: AWS API Documentation
Request Syntax
client.update_id_mapping_table(
idMappingTableIdentifier='string',
membershipIdentifier='string',
description='string',
kmsKeyArn='string'
)
string
[REQUIRED]
The unique identifier of the ID mapping table that you want to update.
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table that you want to update.
string
A new description for the ID mapping table.
string
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
dict
Response Syntax
{
'idMappingTable': {
'id': 'string',
'arn': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'name': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceProperties': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
},
'kmsKeyArn': 'string'
}
}
Response Structure
(dict) --
idMappingTable (dict) --
The updated ID mapping table.
id (string) --
The unique identifier of the ID mapping table.
arn (string) --
The Amazon Resource Name (ARN) of the ID mapping table.
inputReferenceConfig (dict) --
The input reference configuration for the ID mapping table.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
membershipId (string) --
The unique identifier of the membership resource for the ID mapping table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID mapping table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
description (string) --
The description of the ID mapping table.
name (string) --
The name of the ID mapping table.
createTime (datetime) --
The time at which the ID mapping table was created.
updateTime (datetime) --
The most recent time at which the ID mapping table was updated.
inputReferenceProperties (dict) --
The input reference properties for the ID mapping table.
idMappingTableInputSource (list) --
The input source of the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
Returns a list of ID namespace associations.
See also: AWS API Documentation
Request Syntax
client.list_id_namespace_associations(
membershipIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the membership that contains the ID namespace association that you want to view.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
dict
Response Syntax
{
'nextToken': 'string',
'idNamespaceAssociationSummaries': [
{
'membershipId': 'string',
'membershipArn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'id': 'string',
'arn': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'name': 'string',
'description': 'string',
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token value provided to access the next page of results.
idNamespaceAssociationSummaries (list) --
The summary information of the ID namespace associations that you requested.
(dict) --
Detailed information about the ID namespace association.
membershipId (string) --
The unique identifier of the membership resource for this ID namespace association.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID namespace association.
createTime (datetime) --
The time at which this ID namespace association was created.
updateTime (datetime) --
The most recent time at which this ID namespace association has been updated.
id (string) --
The unique identifier of this ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of this ID namespace association.
inputReferenceConfig (dict) --
The input reference configuration details for this ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
name (string) --
The name of the ID namespace association.
description (string) --
The description of the ID namespace association.
inputReferenceProperties (dict) --
The input reference properties for this ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
Creates an ID mapping table.
See also: AWS API Documentation
Request Syntax
client.create_id_mapping_table(
membershipIdentifier='string',
name='string',
description='string',
inputReferenceConfig={
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
tags={
'string': 'string'
},
kmsKeyArn='string'
)
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table.
string
[REQUIRED]
A name for the ID mapping table.
string
A description of the ID mapping table.
dict
[REQUIRED]
The input reference configuration needed to create the ID mapping table.
inputReferenceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
manageResourcePolicies (boolean) -- [REQUIRED]
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
string
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.
dict
Response Syntax
{
'idMappingTable': {
'id': 'string',
'arn': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'name': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceProperties': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
},
'kmsKeyArn': 'string'
}
}
Response Structure
(dict) --
idMappingTable (dict) --
The ID mapping table that was created.
id (string) --
The unique identifier of the ID mapping table.
arn (string) --
The Amazon Resource Name (ARN) of the ID mapping table.
inputReferenceConfig (dict) --
The input reference configuration for the ID mapping table.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
membershipId (string) --
The unique identifier of the membership resource for the ID mapping table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID mapping table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
description (string) --
The description of the ID mapping table.
name (string) --
The name of the ID mapping table.
createTime (datetime) --
The time at which the ID mapping table was created.
updateTime (datetime) --
The most recent time at which the ID mapping table was updated.
inputReferenceProperties (dict) --
The input reference properties for the ID mapping table.
idMappingTableInputSource (list) --
The input source of the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
Returns a list of ID mapping tables.
See also: AWS API Documentation
Request Syntax
client.list_id_mapping_tables(
membershipIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping tables that you want to view.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
dict
Response Syntax
{
'idMappingTableSummaries': [
{
'collaborationArn': 'string',
'collaborationId': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'id': 'string',
'arn': 'string',
'description': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
idMappingTableSummaries (list) --
The summary information of the ID mapping tables that you requested.
(dict) --
Detailed information about the ID mapping table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID mapping table.
membershipId (string) --
The unique identifier of the membership resource for this ID mapping table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.
createTime (datetime) --
The time at which this ID mapping table was created.
updateTime (datetime) --
The most recent time at which this ID mapping table was updated.
id (string) --
The unique identifier of this ID mapping table.
arn (string) --
The Amazon Resource Name (ARN) of this ID mapping table.
description (string) --
The description of this ID mapping table.
inputReferenceConfig (dict) --
The input reference configuration for the ID mapping table.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
name (string) --
The name of this ID mapping table.
nextToken (string) --
The token value provided to access the next page of results.
Creates an ID namespace association.
See also: AWS API Documentation
Request Syntax
client.create_id_namespace_association(
membershipIdentifier='string',
inputReferenceConfig={
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
tags={
'string': 'string'
},
name='string',
description='string',
idMappingConfig={
'allowUseAsDimensionColumn': True|False
}
)
string
[REQUIRED]
The unique identifier of the membership that contains the ID namespace association.
dict
[REQUIRED]
The input reference configuration needed to create the ID namespace association.
inputReferenceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) -- [REQUIRED]
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
string
[REQUIRED]
The name for the ID namespace association.
string
The description of the ID namespace association.
dict
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) -- [REQUIRED]
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
dict
Response Syntax
{
'idNamespaceAssociation': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'name': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET',
'idMappingWorkflowsSupported': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'idMappingConfig': {
'allowUseAsDimensionColumn': True|False
}
}
}
Response Structure
(dict) --
idNamespaceAssociation (dict) --
The ID namespace association that was created.
id (string) --
The unique identifier for this ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of the ID namespace association.
membershipId (string) --
The unique identifier of the membership resource for this ID namespace association.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID namespace association.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
name (string) --
The name of this ID namespace association.
description (string) --
The description of the ID namespace association.
createTime (datetime) --
The time at which the ID namespace association was created.
updateTime (datetime) --
The most recent time at which the ID namespace association was updated.
inputReferenceConfig (dict) --
The input reference configuration for the ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
inputReferenceProperties (dict) --
The input reference properties for the ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
idMappingWorkflowsSupported (list) --
Defines how ID mapping workflows are supported for this ID namespace association.
(:ref:`document<document>`) --
idMappingConfig (dict) --
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) --
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
Deletes an ID namespace association.
See also: AWS API Documentation
Request Syntax
client.delete_id_namespace_association(
idNamespaceAssociationIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the ID namespace association that you want to delete.
string
[REQUIRED]
The unique identifier of the membership that contains the ID namespace association that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves an ID mapping table.
See also: AWS API Documentation
Request Syntax
client.get_id_mapping_table(
idMappingTableIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the ID mapping table identifier that you want to retrieve.
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table that you want to retrieve.
dict
Response Syntax
{
'idMappingTable': {
'id': 'string',
'arn': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'name': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceProperties': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
},
'kmsKeyArn': 'string'
}
}
Response Structure
(dict) --
idMappingTable (dict) --
The ID mapping table that you requested.
id (string) --
The unique identifier of the ID mapping table.
arn (string) --
The Amazon Resource Name (ARN) of the ID mapping table.
inputReferenceConfig (dict) --
The input reference configuration for the ID mapping table.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
membershipId (string) --
The unique identifier of the membership resource for the ID mapping table.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID mapping table.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
description (string) --
The description of the ID mapping table.
name (string) --
The name of the ID mapping table.
createTime (datetime) --
The time at which the ID mapping table was created.
updateTime (datetime) --
The most recent time at which the ID mapping table was updated.
inputReferenceProperties (dict) --
The input reference properties for the ID mapping table.
idMappingTableInputSource (list) --
The input source of the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
Provides the details that are necessary to update an ID namespace association.
See also: AWS API Documentation
Request Syntax
client.update_id_namespace_association(
idNamespaceAssociationIdentifier='string',
membershipIdentifier='string',
name='string',
description='string',
idMappingConfig={
'allowUseAsDimensionColumn': True|False
}
)
string
[REQUIRED]
The unique identifier of the ID namespace association that you want to update.
string
[REQUIRED]
The unique identifier of the membership that contains the ID namespace association that you want to update.
string
A new name for the ID namespace association.
string
A new description for the ID namespace association.
dict
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) -- [REQUIRED]
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
dict
Response Syntax
{
'idNamespaceAssociation': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'name': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET',
'idMappingWorkflowsSupported': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'idMappingConfig': {
'allowUseAsDimensionColumn': True|False
}
}
}
Response Structure
(dict) --
idNamespaceAssociation (dict) --
The updated ID namespace association.
id (string) --
The unique identifier for this ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of the ID namespace association.
membershipId (string) --
The unique identifier of the membership resource for this ID namespace association.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID namespace association.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
name (string) --
The name of this ID namespace association.
description (string) --
The description of the ID namespace association.
createTime (datetime) --
The time at which the ID namespace association was created.
updateTime (datetime) --
The most recent time at which the ID namespace association was updated.
inputReferenceConfig (dict) --
The input reference configuration for the ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
inputReferenceProperties (dict) --
The input reference properties for the ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
idMappingWorkflowsSupported (list) --
Defines how ID mapping workflows are supported for this ID namespace association.
(:ref:`document<document>`) --
idMappingConfig (dict) --
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) --
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
Defines the information that's necessary to populate an ID mapping table.
See also: AWS API Documentation
Request Syntax
client.populate_id_mapping_table(
idMappingTableIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the ID mapping table that you want to populate.
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table that you want to populate.
dict
Response Syntax
{
'idMappingJobId': 'string'
}
Response Structure
(dict) --
idMappingJobId (string) --
The unique identifier of the mapping job that will populate the ID mapping table.
Retrieves an ID namespace association.
See also: AWS API Documentation
Request Syntax
client.get_id_namespace_association(
idNamespaceAssociationIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the ID namespace association that you want to retrieve.
string
[REQUIRED]
The unique identifier of the membership that contains the ID namespace association that you want to retrieve.
dict
Response Syntax
{
'idNamespaceAssociation': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'name': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET',
'idMappingWorkflowsSupported': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'idMappingConfig': {
'allowUseAsDimensionColumn': True|False
}
}
}
Response Structure
(dict) --
idNamespaceAssociation (dict) --
The ID namespace association that you requested.
id (string) --
The unique identifier for this ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of the ID namespace association.
membershipId (string) --
The unique identifier of the membership resource for this ID namespace association.
membershipArn (string) --
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains this ID namespace association.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
name (string) --
The name of this ID namespace association.
description (string) --
The description of the ID namespace association.
createTime (datetime) --
The time at which the ID namespace association was created.
updateTime (datetime) --
The most recent time at which the ID namespace association was updated.
inputReferenceConfig (dict) --
The input reference configuration for the ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
inputReferenceProperties (dict) --
The input reference properties for the ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
idMappingWorkflowsSupported (list) --
Defines how ID mapping workflows are supported for this ID namespace association.
(:ref:`document<document>`) --
idMappingConfig (dict) --
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) --
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
Returns a list of the ID namespace associations in a collaboration.
See also: AWS API Documentation
Request Syntax
client.list_collaboration_id_namespace_associations(
collaborationIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.>
dict
Response Syntax
{
'nextToken': 'string',
'collaborationIdNamespaceAssociationSummaries': [
{
'arn': 'string',
'createTime': datetime(2015, 1, 1),
'id': 'string',
'updateTime': datetime(2015, 1, 1),
'collaborationArn': 'string',
'collaborationId': 'string',
'creatorAccountId': 'string',
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'name': 'string',
'description': 'string',
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token value provided to access the next page of results.
collaborationIdNamespaceAssociationSummaries (list) --
The summary information of the collaboration ID namespace associations that you requested.
(dict) --
Provides summary information about the collaboration ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of the collaboration ID namespace association.
createTime (datetime) --
The time at which the collaboration ID namespace association was created.
id (string) --
The unique identifier of the collaboration ID namespace association.
updateTime (datetime) --
The most recent time at which the collaboration ID namespace association was updated.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains this collaboration ID namespace association.
creatorAccountId (string) --
The Amazon Web Services account that created this collaboration ID namespace association.
inputReferenceConfig (dict) --
The input reference configuration that's used to create the collaboration ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
name (string) --
The name of the collaboration ID namespace association.
description (string) --
The description of the collaboration ID namepsace association.
inputReferenceProperties (dict) --
The input reference properties that are used to create the collaboration ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
Deletes an ID mapping table.
See also: AWS API Documentation
Request Syntax
client.delete_id_mapping_table(
idMappingTableIdentifier='string',
membershipIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the ID mapping table that you want to delete.
string
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table that you want to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves an ID namespace association from a specific collaboration.
See also: AWS API Documentation
Request Syntax
client.get_collaboration_id_namespace_association(
collaborationIdentifier='string',
idNamespaceAssociationIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the collaboration that contains the ID namespace association that you want to retrieve.
string
[REQUIRED]
The unique identifier of the ID namespace association that you want to retrieve.
dict
Response Syntax
{
'collaborationIdNamespaceAssociation': {
'id': 'string',
'arn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'name': 'string',
'description': 'string',
'creatorAccountId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'inputReferenceConfig': {
'inputReferenceArn': 'string',
'manageResourcePolicies': True|False
},
'inputReferenceProperties': {
'idNamespaceType': 'SOURCE'|'TARGET',
'idMappingWorkflowsSupported': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'idMappingConfig': {
'allowUseAsDimensionColumn': True|False
}
}
}
Response Structure
(dict) --
collaborationIdNamespaceAssociation (dict) --
The ID namespace association that you requested.
id (string) --
The unique identifier of the collaboration ID namespace association.
arn (string) --
The Amazon Resource Name (ARN) of the collaboration ID namespace association.
collaborationId (string) --
The unique identifier of the collaboration that contains the collaboration ID namespace association.
collaborationArn (string) --
The Amazon Resource Name (ARN) of the collaboration that contains the collaboration ID namespace association.
name (string) --
The name of the collaboration ID namespace association.
description (string) --
The description of the collaboration ID namespace association.
creatorAccountId (string) --
The unique identifier of the Amazon Web Services account that created the collaboration ID namespace association.
createTime (datetime) --
The time at which the collaboration ID namespace association was created.
updateTime (datetime) --
The most recent time at which the collaboration ID namespace was updated.
inputReferenceConfig (dict) --
The input reference configuration that's necessary to create the collaboration ID namespace association.
inputReferenceArn (string) --
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
manageResourcePolicies (boolean) --
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
inputReferenceProperties (dict) --
The input reference properties that are needed to create the collaboration ID namespace association.
idNamespaceType (string) --
The ID namespace type for this ID namespace association.
idMappingWorkflowsSupported (list) --
Defines how ID mapping workflows are supported for this ID namespace association.
(:ref:`document<document>`) --
idMappingConfig (dict) --
The configuration settings for the ID mapping table.
allowUseAsDimensionColumn (boolean) --
An indicator as to whether you can use your column as a dimension column in the ID mapping table ( TRUE) or not ( FALSE).
Default is FALSE.
{'schemas': {'analysisRuleTypes': {'ID_MAPPING_TABLE'},
'schemaStatusDetails': {'analysisRuleType': {'ID_MAPPING_TABLE'},
'configurations': {'CUSTOM_ANALYSIS_NOT_ALLOWED',
'DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED',
'ID_MAPPING_TABLE_NOT_POPULATED',
'NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS'},
'reasons': {'code': {'ID_MAPPING_TABLE_NOT_POPULATED'}}},
'schemaTypeProperties': {'idMappingTable': {'idMappingTableInputSource': [{'idNamespaceAssociationId': 'string',
'type': 'SOURCE '
'| '
'TARGET'}]}},
'type': {'ID_MAPPING_TABLE'}}}
Retrieves multiple schemas by their identifiers.
See also: AWS API Documentation
Request Syntax
client.batch_get_schema(
collaborationIdentifier='string',
names=[
'string',
]
)
string
[REQUIRED]
A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
list
[REQUIRED]
The names for the schema objects to retrieve.
(string) --
dict
Response Syntax
{
'schemas': [
{
'columns': [
{
'name': 'string',
'type': 'string'
},
],
'partitionKeys': [
{
'name': 'string',
'type': 'string'
},
],
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY',
'creatorAccountId': 'string',
'name': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'type': 'TABLE'|'ID_MAPPING_TABLE',
'schemaStatusDetails': [
{
'status': 'READY'|'NOT_READY',
'reasons': [
{
'code': 'ANALYSIS_RULE_MISSING'|'ANALYSIS_TEMPLATES_NOT_CONFIGURED'|'ANALYSIS_PROVIDERS_NOT_CONFIGURED'|'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED',
'message': 'string'
},
],
'analysisRuleType': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'configurations': [
'DIFFERENTIAL_PRIVACY'|'CUSTOM_ANALYSIS_NOT_ALLOWED'|'NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS'|'DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED',
]
},
],
'schemaTypeProperties': {
'idMappingTable': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
}
}
},
],
'errors': [
{
'name': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
schemas (list) --
The retrieved list of schemas.
(dict) --
A schema is a relation within a collaboration.
columns (list) --
The columns for the relation that this schema represents.
(dict) --
A column within a schema relation, derived from the underlying Glue table.
name (string) --
The name of the column.
type (string) --
The type of the column.
partitionKeys (list) --
The partition keys for the dataset underlying this schema.
(dict) --
A column within a schema relation, derived from the underlying Glue table.
name (string) --
The name of the column.
type (string) --
The type of the column.
analysisRuleTypes (list) --
The analysis rule types that are associated with the schema. Currently, only one entry is present.
(string) --
analysisMethod (string) --
The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
name (string) --
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
description (string) --
A description for the schema.
createTime (datetime) --
The time at which the schema was created.
updateTime (datetime) --
The most recent time at which the schema was updated.
type (string) --
The type of schema.
schemaStatusDetails (list) --
Details about the status of the schema. Currently, only one entry is present.
(dict) --
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
status (string) --
The status of the schema.
reasons (list) --
The reasons why the schema status is set to its current state.
(dict) --
A reason why the schema status is set to its current value.
code (string) --
The schema status reason code.
message (string) --
An explanation of the schema status reason code.
analysisRuleType (string) --
The analysis rule type for which the schema status has been evaluated.
configurations (list) --
The configuration details of the schema analysis rule for the given type.
(string) --
schemaTypeProperties (dict) --
The schema type properties.
idMappingTable (dict) --
The ID mapping table for the schema type properties.
idMappingTableInputSource (list) --
Defines which ID namespace associations are used to create the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
errors (list) --
Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
(dict) --
An error describing why a schema could not be fetched.
name (string) --
An error name for the error.
code (string) --
An error code for the error.
message (string) --
An error message for the error.
{'schemaAnalysisRuleRequests': {'type': {'ID_MAPPING_TABLE'}}}
Response {'analysisRules': {'policy': {'v1': {'idMappingTable': {'dimensionColumns': ['string'],
'joinColumns': ['string'],
'queryConstraints': [{'requireOverlap': {'columns': ['string']}}]}}},
'type': {'ID_MAPPING_TABLE'}},
'errors': {'type': {'ID_MAPPING_TABLE'}}}
Retrieves multiple analysis rule schemas.
See also: AWS API Documentation
Request Syntax
client.batch_get_schema_analysis_rule(
collaborationIdentifier='string',
schemaAnalysisRuleRequests=[
{
'name': 'string',
'type': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE'
},
]
)
string
[REQUIRED]
The unique identifier of the collaboration that contains the schema analysis rule.
list
[REQUIRED]
The information that's necessary to retrieve a schema analysis rule.
(dict) --
Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.
name (string) -- [REQUIRED]
The name of the analysis rule schema that you are requesting.
type (string) -- [REQUIRED]
The type of analysis rule schema that you are requesting.
dict
Response Syntax
{
'analysisRules': [
{
'collaborationId': 'string',
'type': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'name': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'policy': {
'v1': {
'list': {
'joinColumns': [
'string',
],
'allowedJoinOperators': [
'OR'|'AND',
],
'listColumns': [
'string',
]
},
'aggregation': {
'aggregateColumns': [
{
'columnNames': [
'string',
],
'function': 'SUM'|'SUM_DISTINCT'|'COUNT'|'COUNT_DISTINCT'|'AVG'
},
],
'joinColumns': [
'string',
],
'joinRequired': 'QUERY_RUNNER',
'allowedJoinOperators': [
'OR'|'AND',
],
'dimensionColumns': [
'string',
],
'scalarFunctions': [
'ABS'|'CAST'|'CEILING'|'COALESCE'|'CONVERT'|'CURRENT_DATE'|'DATEADD'|'EXTRACT'|'FLOOR'|'GETDATE'|'LN'|'LOG'|'LOWER'|'ROUND'|'RTRIM'|'SQRT'|'SUBSTRING'|'TO_CHAR'|'TO_DATE'|'TO_NUMBER'|'TO_TIMESTAMP'|'TRIM'|'TRUNC'|'UPPER',
],
'outputConstraints': [
{
'columnName': 'string',
'minimum': 123,
'type': 'COUNT_DISTINCT'
},
]
},
'custom': {
'allowedAnalyses': [
'string',
],
'allowedAnalysisProviders': [
'string',
],
'differentialPrivacy': {
'columns': [
{
'name': 'string'
},
]
}
},
'idMappingTable': {
'joinColumns': [
'string',
],
'queryConstraints': [
{
'requireOverlap': {
'columns': [
'string',
]
}
},
],
'dimensionColumns': [
'string',
]
}
}
}
},
],
'errors': [
{
'name': 'string',
'type': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
analysisRules (list) --
The retrieved list of analysis rules.
(dict) --
A specification about how data from the configured table can be used in a query.
collaborationId (string) --
The unique ID for the associated collaboration.
type (string) --
The type of analysis rule.
name (string) --
The name for the analysis rule.
createTime (datetime) --
The time the analysis rule was created.
updateTime (datetime) --
The time the analysis rule was last updated.
policy (dict) --
A policy that describes the associated data usage limitations.
v1 (dict) --
Controls on the query specifications that can be run on configured table.
list (dict) --
Analysis rule type that enables only list queries on a configured table.
joinColumns (list) --
Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
(string) --
allowedJoinOperators (list) --
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
(string) --
listColumns (list) --
Columns that can be listed in the output.
(string) --
aggregation (dict) --
Analysis rule type that enables only aggregation queries on a configured table.
aggregateColumns (list) --
The columns that query runners are allowed to use in aggregation queries.
(dict) --
Column in configured table that can be used in aggregate function in query.
columnNames (list) --
Column names in configured table of aggregate columns.
(string) --
function (string) --
Aggregation function that can be applied to aggregate column in query.
joinColumns (list) --
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
(string) --
joinRequired (string) --
Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
allowedJoinOperators (list) --
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
(string) --
dimensionColumns (list) --
The columns that query runners are allowed to select, group by, or filter by.
(string) --
scalarFunctions (list) --
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
(string) --
outputConstraints (list) --
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
(dict) --
Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
columnName (string) --
Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
minimum (integer) --
The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
type (string) --
The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.
custom (dict) --
Analysis rule type that enables custom SQL queries on a configured table.
allowedAnalyses (list) --
The ARN of the analysis templates that are allowed by the custom analysis rule.
(string) --
allowedAnalysisProviders (list) --
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
(string) --
differentialPrivacy (dict) --
The differential privacy configuration.
columns (list) --
The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
(dict) --
Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
name (string) --
The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
idMappingTable (dict) --
The ID mapping table.
joinColumns (list) --
The columns that query runners are allowed to use in an INNER JOIN statement.
(string) --
queryConstraints (list) --
The query constraints of the analysis rule ID mapping table.
(dict) --
Provides any necessary query constraint information.
requireOverlap (dict) --
An array of column names that specifies which columns are required in the JOIN statement.
columns (list) --
The columns that are required to overlap.
(string) --
dimensionColumns (list) --
The columns that query runners are allowed to select, group by, or filter by.
(string) --
errors (list) --
Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
(dict) --
An error that describes why a schema could not be fetched.
name (string) --
An error name for the error.
type (string) --
The analysis rule type.
code (string) --
An error code for the error.
message (string) --
A description of why the call failed.
{'schema': {'analysisRuleTypes': {'ID_MAPPING_TABLE'},
'schemaStatusDetails': {'analysisRuleType': {'ID_MAPPING_TABLE'},
'configurations': {'CUSTOM_ANALYSIS_NOT_ALLOWED',
'DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED',
'ID_MAPPING_TABLE_NOT_POPULATED',
'NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS'},
'reasons': {'code': {'ID_MAPPING_TABLE_NOT_POPULATED'}}},
'schemaTypeProperties': {'idMappingTable': {'idMappingTableInputSource': [{'idNamespaceAssociationId': 'string',
'type': 'SOURCE '
'| '
'TARGET'}]}},
'type': {'ID_MAPPING_TABLE'}}}
Retrieves the schema for a relation within a collaboration.
See also: AWS API Documentation
Request Syntax
client.get_schema(
collaborationIdentifier='string',
name='string'
)
string
[REQUIRED]
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
string
[REQUIRED]
The name of the relation to retrieve the schema for.
dict
Response Syntax
{
'schema': {
'columns': [
{
'name': 'string',
'type': 'string'
},
],
'partitionKeys': [
{
'name': 'string',
'type': 'string'
},
],
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY',
'creatorAccountId': 'string',
'name': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'type': 'TABLE'|'ID_MAPPING_TABLE',
'schemaStatusDetails': [
{
'status': 'READY'|'NOT_READY',
'reasons': [
{
'code': 'ANALYSIS_RULE_MISSING'|'ANALYSIS_TEMPLATES_NOT_CONFIGURED'|'ANALYSIS_PROVIDERS_NOT_CONFIGURED'|'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED',
'message': 'string'
},
],
'analysisRuleType': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'configurations': [
'DIFFERENTIAL_PRIVACY'|'CUSTOM_ANALYSIS_NOT_ALLOWED'|'NO_MEMBER_ACCOUNT_ALLOWED_TO_PROVIDE_ANALYSIS'|'DIFFERENTIAL_PRIVACY_BUDGET_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED',
]
},
],
'schemaTypeProperties': {
'idMappingTable': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
}
}
}
}
Response Structure
(dict) --
schema (dict) --
The entire schema object.
columns (list) --
The columns for the relation that this schema represents.
(dict) --
A column within a schema relation, derived from the underlying Glue table.
name (string) --
The name of the column.
type (string) --
The type of the column.
partitionKeys (list) --
The partition keys for the dataset underlying this schema.
(dict) --
A column within a schema relation, derived from the underlying Glue table.
name (string) --
The name of the column.
type (string) --
The type of the column.
analysisRuleTypes (list) --
The analysis rule types that are associated with the schema. Currently, only one entry is present.
(string) --
analysisMethod (string) --
The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
name (string) --
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
description (string) --
A description for the schema.
createTime (datetime) --
The time at which the schema was created.
updateTime (datetime) --
The most recent time at which the schema was updated.
type (string) --
The type of schema.
schemaStatusDetails (list) --
Details about the status of the schema. Currently, only one entry is present.
(dict) --
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
status (string) --
The status of the schema.
reasons (list) --
The reasons why the schema status is set to its current state.
(dict) --
A reason why the schema status is set to its current value.
code (string) --
The schema status reason code.
message (string) --
An explanation of the schema status reason code.
analysisRuleType (string) --
The analysis rule type for which the schema status has been evaluated.
configurations (list) --
The configuration details of the schema analysis rule for the given type.
(string) --
schemaTypeProperties (dict) --
The schema type properties.
idMappingTable (dict) --
The ID mapping table for the schema type properties.
idMappingTableInputSource (list) --
Defines which ID namespace associations are used to create the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
{'type': {'ID_MAPPING_TABLE'}}
Response {'analysisRule': {'policy': {'v1': {'idMappingTable': {'dimensionColumns': ['string'],
'joinColumns': ['string'],
'queryConstraints': [{'requireOverlap': {'columns': ['string']}}]}}},
'type': {'ID_MAPPING_TABLE'}}}
Retrieves a schema analysis rule.
See also: AWS API Documentation
Request Syntax
client.get_schema_analysis_rule(
collaborationIdentifier='string',
name='string',
type='AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE'
)
string
[REQUIRED]
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
string
[REQUIRED]
The name of the schema to retrieve the analysis rule for.
string
[REQUIRED]
The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
dict
Response Syntax
{
'analysisRule': {
'collaborationId': 'string',
'type': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'name': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'policy': {
'v1': {
'list': {
'joinColumns': [
'string',
],
'allowedJoinOperators': [
'OR'|'AND',
],
'listColumns': [
'string',
]
},
'aggregation': {
'aggregateColumns': [
{
'columnNames': [
'string',
],
'function': 'SUM'|'SUM_DISTINCT'|'COUNT'|'COUNT_DISTINCT'|'AVG'
},
],
'joinColumns': [
'string',
],
'joinRequired': 'QUERY_RUNNER',
'allowedJoinOperators': [
'OR'|'AND',
],
'dimensionColumns': [
'string',
],
'scalarFunctions': [
'ABS'|'CAST'|'CEILING'|'COALESCE'|'CONVERT'|'CURRENT_DATE'|'DATEADD'|'EXTRACT'|'FLOOR'|'GETDATE'|'LN'|'LOG'|'LOWER'|'ROUND'|'RTRIM'|'SQRT'|'SUBSTRING'|'TO_CHAR'|'TO_DATE'|'TO_NUMBER'|'TO_TIMESTAMP'|'TRIM'|'TRUNC'|'UPPER',
],
'outputConstraints': [
{
'columnName': 'string',
'minimum': 123,
'type': 'COUNT_DISTINCT'
},
]
},
'custom': {
'allowedAnalyses': [
'string',
],
'allowedAnalysisProviders': [
'string',
],
'differentialPrivacy': {
'columns': [
{
'name': 'string'
},
]
}
},
'idMappingTable': {
'joinColumns': [
'string',
],
'queryConstraints': [
{
'requireOverlap': {
'columns': [
'string',
]
}
},
],
'dimensionColumns': [
'string',
]
}
}
}
}
}
Response Structure
(dict) --
analysisRule (dict) --
A specification about how data from the configured table can be used.
collaborationId (string) --
The unique ID for the associated collaboration.
type (string) --
The type of analysis rule.
name (string) --
The name for the analysis rule.
createTime (datetime) --
The time the analysis rule was created.
updateTime (datetime) --
The time the analysis rule was last updated.
policy (dict) --
A policy that describes the associated data usage limitations.
v1 (dict) --
Controls on the query specifications that can be run on configured table.
list (dict) --
Analysis rule type that enables only list queries on a configured table.
joinColumns (list) --
Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
(string) --
allowedJoinOperators (list) --
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
(string) --
listColumns (list) --
Columns that can be listed in the output.
(string) --
aggregation (dict) --
Analysis rule type that enables only aggregation queries on a configured table.
aggregateColumns (list) --
The columns that query runners are allowed to use in aggregation queries.
(dict) --
Column in configured table that can be used in aggregate function in query.
columnNames (list) --
Column names in configured table of aggregate columns.
(string) --
function (string) --
Aggregation function that can be applied to aggregate column in query.
joinColumns (list) --
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
(string) --
joinRequired (string) --
Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
allowedJoinOperators (list) --
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
(string) --
dimensionColumns (list) --
The columns that query runners are allowed to select, group by, or filter by.
(string) --
scalarFunctions (list) --
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
(string) --
outputConstraints (list) --
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
(dict) --
Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
columnName (string) --
Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
minimum (integer) --
The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
type (string) --
The type of aggregation the constraint allows. The only valid value is currently COUNT_DISTINCT.
custom (dict) --
Analysis rule type that enables custom SQL queries on a configured table.
allowedAnalyses (list) --
The ARN of the analysis templates that are allowed by the custom analysis rule.
(string) --
allowedAnalysisProviders (list) --
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
(string) --
differentialPrivacy (dict) --
The differential privacy configuration.
columns (list) --
The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
(dict) --
Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.
name (string) --
The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
idMappingTable (dict) --
The ID mapping table.
joinColumns (list) --
The columns that query runners are allowed to use in an INNER JOIN statement.
(string) --
queryConstraints (list) --
The query constraints of the analysis rule ID mapping table.
(dict) --
Provides any necessary query constraint information.
requireOverlap (dict) --
An array of column names that specifies which columns are required in the JOIN statement.
columns (list) --
The columns that are required to overlap.
(string) --
dimensionColumns (list) --
The columns that query runners are allowed to select, group by, or filter by.
(string) --
{'schemaType': {'ID_MAPPING_TABLE'}}
Response {'schemaSummaries': {'analysisRuleTypes': {'ID_MAPPING_TABLE'},
'type': {'ID_MAPPING_TABLE'}}}
Lists the schemas for relations within a collaboration.
See also: AWS API Documentation
Request Syntax
client.list_schemas(
collaborationIdentifier='string',
schemaType='TABLE'|'ID_MAPPING_TABLE',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
string
If present, filter schemas by schema type.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'schemaSummaries': [
{
'name': 'string',
'type': 'TABLE'|'ID_MAPPING_TABLE',
'creatorAccountId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'collaborationId': 'string',
'collaborationArn': 'string',
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
schemaSummaries (list) --
The retrieved list of schemas.
(dict) --
The schema summary for the objects listed by the request.
name (string) --
The name for the schema object.
type (string) --
The type of schema object.
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
createTime (datetime) --
The time the schema object was created.
updateTime (datetime) --
The time the schema object was last updated.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique ARN for the collaboration that the schema belongs to.
analysisRuleTypes (list) --
The types of analysis rules that are associated with this schema object.
(string) --
analysisMethod (string) --
The analysis method for the associated schema. The only valid value is currently DIRECT_QUERY.
nextToken (string) --
The pagination token that's used to fetch the next set of results.